udmf_sys/udmf/udmf_ffi.rs
1// automatically generated by rust-bindgen 0.71.1
2
3#![allow(non_upper_case_globals)]
4#![allow(non_camel_case_types)]
5#![allow(non_snake_case)]
6use ohos_sys_opaque_types::*;
7
8pub const UDMF_KEY_BUFFER_LEN: u32 = 512;
9#[cfg(feature = "api-12")]
10#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
11impl Udmf_Intention {
12 /// The intention is drag.
13 pub const DRAG: Udmf_Intention = Udmf_Intention(0);
14 /// The intention is pasteboard.
15 pub const PASTEBOARD: Udmf_Intention = Udmf_Intention(1);
16}
17#[repr(transparent)]
18/// Describe the intention type of the udmf.
19///
20///
21/// Available since API-level: 12
22#[cfg(feature = "api-12")]
23#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
24#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
25pub struct Udmf_Intention(pub ::core::ffi::c_uint);
26#[cfg(feature = "api-12")]
27#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
28impl Udmf_ShareOption {
29 /// Invalid share option.
30 pub const INVALID: Udmf_ShareOption = Udmf_ShareOption(0);
31 /// Allowed to be used in the same application on this device.
32 pub const IN_APP: Udmf_ShareOption = Udmf_ShareOption(1);
33 /// Allowed to be used in the cross application on this device.
34 pub const CROSS_APP: Udmf_ShareOption = Udmf_ShareOption(2);
35}
36#[repr(transparent)]
37/// Describe intra-device usage range type enumeration.
38///
39///
40/// Available since API-level: 12
41#[cfg(feature = "api-12")]
42#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
43#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
44pub struct Udmf_ShareOption(pub ::core::ffi::c_uint);
45#[cfg(feature = "api-15")]
46#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
47impl Udmf_FileConflictOptions {
48 /// Overwrite when dest uri has file with same name.
49 pub const UDMF_OVERWRITE: Udmf_FileConflictOptions = Udmf_FileConflictOptions(0);
50 /// Skip when dest uri has file with same name.
51 pub const UDMF_SKIP: Udmf_FileConflictOptions = Udmf_FileConflictOptions(1);
52}
53#[repr(transparent)]
54/// Describe the types of file conflict options when getting data from the udmf.
55///
56///
57/// Available since API-level: 15
58#[cfg(feature = "api-15")]
59#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
60#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
61pub struct Udmf_FileConflictOptions(pub ::core::ffi::c_uint);
62#[cfg(feature = "api-15")]
63#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
64impl Udmf_ProgressIndicator {
65 /// Getting data without system default progress indicator.
66 pub const UDMF_NONE: Udmf_ProgressIndicator = Udmf_ProgressIndicator(0);
67 /// Getting data with system default progress indicator.
68 pub const UDMF_DEFAULT: Udmf_ProgressIndicator = Udmf_ProgressIndicator(1);
69}
70#[repr(transparent)]
71/// Describe the types of progress indicator when getting data from the udmf.
72///
73///
74/// Available since API-level: 15
75#[cfg(feature = "api-15")]
76#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
77#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
78pub struct Udmf_ProgressIndicator(pub ::core::ffi::c_uint);
79/// Represents the udmf progress information.
80///
81///
82/// Available since API-level: 15
83#[cfg(feature = "api-15")]
84#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
85#[repr(C)]
86pub struct OH_Udmf_ProgressInfo {
87 _unused: [u8; 0],
88}
89/// Defines the callback function used to return the progress information and data.
90///
91/// # Arguments
92///
93/// * `progressInfo` - The progress information notified to Application.
94///
95/// * `data` - Represents the unified data.
96///
97/// Available since API-level: 15
98#[cfg(feature = "api-15")]
99#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
100pub type OH_Udmf_DataProgressListener = ::core::option::Option<
101 unsafe extern "C" fn(progressInfo: *mut OH_Udmf_ProgressInfo, data: *mut OH_UdmfData),
102>;
103/// Defines the callback function used free the context.
104/// # Arguments
105///
106/// * `context` - Pointer to the context which is to be free.
107///
108/// Available since API-level: 13
109#[cfg(feature = "api-13")]
110#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
111pub type UdmfData_Finalize =
112 ::core::option::Option<unsafe extern "C" fn(context: *mut ::core::ffi::c_void)>;
113/// Defines a callback function used to obtain data by type.
114///
115/// # Arguments
116///
117/// * `context` - Pointer to the context set by [`OH_UdmfRecordProvider_SetData`].
118///
119/// * `type` - Pointer to the type of data to obtain. For details, see [`udmf_meta.h`].
120///
121/// # Returns
122///
123/// * Returns the data content.
124///
125/// Available since API-level: 13
126#[cfg(feature = "api-13")]
127#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
128pub type OH_UdmfRecordProvider_GetData = ::core::option::Option<
129 unsafe extern "C" fn(
130 context: *mut ::core::ffi::c_void,
131 type_: *const ::core::ffi::c_char,
132 ) -> *mut ::core::ffi::c_void,
133>;
134extern "C" {
135 /// Creation a pointer to the instance of the [`OH_UdmfData`].
136 ///
137 ///
138 /// # Returns
139 ///
140 /// * If the operation is successful, a pointer to the instance of the [`OH_UdmfData`]
141 /// structure is returned. If the operation is failed, nullptr is returned.
142 /// [`OH_UdmfData.`]
143 /// Available since API-level: 12
144 #[cfg(feature = "api-12")]
145 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
146 pub fn OH_UdmfData_Create() -> *mut OH_UdmfData;
147 /// Destroy a pointer that points to the [`OH_UdmfData`] instance.
148 ///
149 /// # Arguments
150 ///
151 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfData`].
152 /// [`OH_UdmfData.`]
153 /// Available since API-level: 12
154 #[cfg(feature = "api-12")]
155 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
156 pub fn OH_UdmfData_Destroy(pThis: *mut OH_UdmfData);
157 /// Add one {OH_UdmfRecord} record to the [`OH_UdmfData`] data.
158 ///
159 /// # Arguments
160 ///
161 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfData`].
162 ///
163 /// * `record` - Represents a pointer to an instance of [`OH_UdmfRecord`].
164 ///
165 /// # Returns
166 ///
167 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
168 /// [`UDMF_E_OK`] success.
169 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
170 /// [`OH_UdmfData`] Udmf_ErrCode.
171 ///
172 /// Available since API-level: 12
173 #[cfg(feature = "api-12")]
174 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
175 pub fn OH_UdmfData_AddRecord(
176 pThis: *mut OH_UdmfData,
177 record: *mut OH_UdmfRecord,
178 ) -> ::core::ffi::c_int;
179 /// Check whether the type exists in the [`OH_UdmfData`] data.
180 ///
181 /// # Arguments
182 ///
183 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfData`].
184 ///
185 /// * `type` - Represents a string pointer of the type.
186 ///
187 /// # Returns
188 ///
189 /// * Returns the status of finding type.
190 /// `false` is not existed.
191 /// `true` is existed.
192 /// [`OH_UdmfData.`]
193 /// Available since API-level: 12
194 #[cfg(feature = "api-12")]
195 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
196 pub fn OH_UdmfData_HasType(pThis: *mut OH_UdmfData, type_: *const ::core::ffi::c_char) -> bool;
197 /// Get all types in the [`OH_UdmfData`] data.
198 ///
199 /// # Arguments
200 ///
201 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfData`].
202 ///
203 /// * `count` - Represents the types count that is a output param.
204 ///
205 /// # Returns
206 ///
207 /// * Returns string array that in [`OH_UdmfData`] when input parameters valid,
208 /// otherwise return nullptr.
209 /// [`OH_UdmfData.`]
210 /// Available since API-level: 12
211 #[cfg(feature = "api-12")]
212 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
213 pub fn OH_UdmfData_GetTypes(
214 pThis: *mut OH_UdmfData,
215 count: *mut ::core::ffi::c_uint,
216 ) -> *mut *mut ::core::ffi::c_char;
217 /// Get all records in the [`OH_UdmfData`] data.
218 ///
219 /// # Arguments
220 ///
221 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfData`].
222 ///
223 /// * `count` - Represents the records count that is a output param.
224 ///
225 /// # Returns
226 ///
227 /// * Returns [`OH_UdmfRecord`] pointer array when input parameters valid, otherwise return nullptr.
228 /// [`OH_UdmfData`] OH_UdmfRecord.
229 ///
230 /// Available since API-level: 12
231 #[cfg(feature = "api-12")]
232 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
233 pub fn OH_UdmfData_GetRecords(
234 pThis: *mut OH_UdmfData,
235 count: *mut ::core::ffi::c_uint,
236 ) -> *mut *mut OH_UdmfRecord;
237 /// Creates an [`OH_UdmfRecordProvider`] instance.
238 ///
239 ///
240 /// # Returns
241 ///
242 /// * Returns the pointer to the [`OH_UdmfRecordProvider`] instance created if the operation is successful.
243 /// Returns nullptr if the memory is not enough.
244 /// [`OH_UdmfRecordProvider.`]
245 /// Available since API-level: 13
246 #[cfg(feature = "api-13")]
247 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
248 pub fn OH_UdmfRecordProvider_Create() -> *mut OH_UdmfRecordProvider;
249 /// Destroy an [`OH_UdmfRecordProvider`] instance.
250 ///
251 /// # Arguments
252 ///
253 /// * `provider` - Pointer to the [`OH_UdmfRecordProvider`] instance to destroy.
254 ///
255 /// # Returns
256 ///
257 /// * Returns the status code of the execution. For details, see [`Udmf_ErrCode`].
258 /// Returns [`UDMF_E_OK`] if the operation is successful.
259 /// Returns [`UDMF_E_INVALID_PARAM`] if invalid args are detected.
260 /// [`OH_UdmfRecordProvider`] Udmf_ErrCode.
261 ///
262 /// Available since API-level: 13
263 #[cfg(feature = "api-13")]
264 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
265 pub fn OH_UdmfRecordProvider_Destroy(
266 provider: *mut OH_UdmfRecordProvider,
267 ) -> ::core::ffi::c_int;
268 /// Sets a callback function to obtain data.
269 ///
270 /// # Arguments
271 ///
272 /// * `provider` - Pointer to the [`OH_UdmfRecordProvider`] instance.
273 ///
274 /// * `context` - Pointer to the context set, which is the first parameter in OH_UdmfRecordProvider_GetData.
275 ///
276 /// * `callback` - Callback to set. For details, see [`OH_UdmfRecordProvider_GetData`].
277 ///
278 /// * `finalize` - Optional callback that can free context when destroy provider.
279 /// For details, see [`UdmfData_Finalize`].
280 ///
281 /// # Returns
282 ///
283 /// * Returns the status code of the execution. For details, see [`Udmf_ErrCode`].
284 /// Returns [`UDMF_E_OK`] if the operation is successful.
285 /// Returns [`UDMF_E_INVALID_PARAM`] if invalid args are detected.
286 /// [`OH_UdmfRecordProvider`] OH_UdmfRecordProvider_GetData UdmfData_Finalize Udmf_ErrCode.
287 ///
288 /// Available since API-level: 13
289 #[cfg(feature = "api-13")]
290 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
291 pub fn OH_UdmfRecordProvider_SetData(
292 provider: *mut OH_UdmfRecordProvider,
293 context: *mut ::core::ffi::c_void,
294 callback: OH_UdmfRecordProvider_GetData,
295 finalize: UdmfData_Finalize,
296 ) -> ::core::ffi::c_int;
297 /// Creation a pointer to the instance of the [`OH_UdmfRecord`], it's relate with UDS data.
298 ///
299 ///
300 /// # Returns
301 ///
302 /// * If the operation is successful, a pointer to the instance of the [`OH_UdmfRecord`]
303 /// structure is returned. If the operation is failed, nullptr is returned.
304 /// [`OH_UdmfRecord.`]
305 /// Available since API-level: 12
306 #[cfg(feature = "api-12")]
307 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
308 pub fn OH_UdmfRecord_Create() -> *mut OH_UdmfRecord;
309 /// Destroy a pointer that points to an instance of [`OH_UdmfRecord`].
310 ///
311 /// # Arguments
312 ///
313 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
314 /// [`OH_UdmfRecord.`]
315 /// Available since API-level: 12
316 #[cfg(feature = "api-12")]
317 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
318 pub fn OH_UdmfRecord_Destroy(pThis: *mut OH_UdmfRecord);
319 /// Add one custom data to the [`OH_UdmfRecord`] record.
320 ///
321 /// # Arguments
322 ///
323 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
324 ///
325 /// * `typeId` - Represents record type, reference udmf_meta.h.
326 ///
327 /// * `entry` - Represents custom data.
328 ///
329 /// * `count` - Represents the size of data param.
330 ///
331 /// # Returns
332 ///
333 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
334 /// [`UDMF_E_OK`] success.
335 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
336 /// [`OH_UdmfRecord`] Udmf_ErrCode.
337 ///
338 /// Available since API-level: 12
339 #[cfg(feature = "api-12")]
340 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
341 pub fn OH_UdmfRecord_AddGeneralEntry(
342 pThis: *mut OH_UdmfRecord,
343 typeId: *const ::core::ffi::c_char,
344 entry: *mut ::core::ffi::c_uchar,
345 count: ::core::ffi::c_uint,
346 ) -> ::core::ffi::c_int;
347 /// Add one {OH_UdsPlainText} data to the [`OH_UdmfRecord`] record.
348 ///
349 /// # Arguments
350 ///
351 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
352 ///
353 /// * `plainText` - Represents a pointer to an instance of [`OH_UdsPlainText`].
354 ///
355 /// # Returns
356 ///
357 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
358 /// [`UDMF_E_OK`] success.
359 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
360 /// [`OH_UdmfRecord`] OH_UdsPlainText Udmf_ErrCode.
361 ///
362 /// Available since API-level: 12
363 #[cfg(feature = "api-12")]
364 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
365 pub fn OH_UdmfRecord_AddPlainText(
366 pThis: *mut OH_UdmfRecord,
367 plainText: *mut OH_UdsPlainText,
368 ) -> ::core::ffi::c_int;
369 /// Add one {OH_UdsHyperlink} data to the [`OH_UdmfRecord`] record.
370 ///
371 /// # Arguments
372 ///
373 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
374 ///
375 /// * `hyperlink` - Represents a pointer to an instance of [`OH_UdsHyperlink`].
376 ///
377 /// # Returns
378 ///
379 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
380 /// [`UDMF_E_OK`] success.
381 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
382 /// [`OH_UdmfRecord`] OH_UdsHyperlink Udmf_ErrCode.
383 ///
384 /// Available since API-level: 12
385 #[cfg(feature = "api-12")]
386 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
387 pub fn OH_UdmfRecord_AddHyperlink(
388 pThis: *mut OH_UdmfRecord,
389 hyperlink: *mut OH_UdsHyperlink,
390 ) -> ::core::ffi::c_int;
391 /// Add one {OH_UdsHtml} data to the [`OH_UdmfRecord`] record.
392 ///
393 /// # Arguments
394 ///
395 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
396 ///
397 /// * `html` - Represents a pointer to an instance of [`OH_UdsHtml`].
398 ///
399 /// # Returns
400 ///
401 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
402 /// [`UDMF_E_OK`] success.
403 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
404 /// [`OH_UdmfRecord`] OH_UdsHtml Udmf_ErrCode.
405 ///
406 /// Available since API-level: 12
407 #[cfg(feature = "api-12")]
408 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
409 pub fn OH_UdmfRecord_AddHtml(
410 pThis: *mut OH_UdmfRecord,
411 html: *mut OH_UdsHtml,
412 ) -> ::core::ffi::c_int;
413 /// Add one {OH_UdsAppItem} data to the [`OH_UdmfRecord`] record.
414 ///
415 /// # Arguments
416 ///
417 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
418 ///
419 /// * `appItem` - Represents a pointer to an instance of [`OH_UdsAppItem`].
420 ///
421 /// # Returns
422 ///
423 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
424 /// [`UDMF_E_OK`] success.
425 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
426 /// [`OH_UdmfRecord`] OH_UdsAppItem Udmf_ErrCode.
427 ///
428 /// Available since API-level: 12
429 #[cfg(feature = "api-12")]
430 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
431 pub fn OH_UdmfRecord_AddAppItem(
432 pThis: *mut OH_UdmfRecord,
433 appItem: *mut OH_UdsAppItem,
434 ) -> ::core::ffi::c_int;
435 /// Add one {OH_UdsFileUri} data to the [`OH_UdmfRecord`] record.
436 ///
437 /// # Arguments
438 ///
439 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
440 ///
441 /// * `fileUri` - Represents a pointer to an instance of [`OH_UdsFileUri`].
442 ///
443 /// # Returns
444 ///
445 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
446 /// [`UDMF_E_OK`] success.
447 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
448 /// [`OH_UdmfRecord`] OH_UdsFileUri Udmf_ErrCode.
449 ///
450 /// Available since API-level: 13
451 #[cfg(feature = "api-13")]
452 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
453 pub fn OH_UdmfRecord_AddFileUri(
454 pThis: *mut OH_UdmfRecord,
455 fileUri: *mut OH_UdsFileUri,
456 ) -> ::core::ffi::c_int;
457 /// Add one {OH_UdsPixelMap} data to the [`OH_UdmfRecord`] record.
458 ///
459 /// # Arguments
460 ///
461 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
462 ///
463 /// * `pixelMap` - Represents a pointer to an instance of [`OH_UdsPixelMap`].
464 ///
465 /// # Returns
466 ///
467 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
468 /// [`UDMF_E_OK`] success.
469 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
470 /// [`OH_UdmfRecord`] OH_UdsPixelMap Udmf_ErrCode.
471 ///
472 /// Available since API-level: 13
473 #[cfg(feature = "api-13")]
474 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
475 pub fn OH_UdmfRecord_AddPixelMap(
476 pThis: *mut OH_UdmfRecord,
477 pixelMap: *mut OH_UdsPixelMap,
478 ) -> ::core::ffi::c_int;
479 /// Add one [`OH_UdsArrayBuffer`] data to the [`OH_UdmfRecord`] record.
480 ///
481 /// # Arguments
482 ///
483 /// * `record` - Represents a pointer to an instance of [`OH_UdmfRecord`].
484 ///
485 /// * `type` - Represents record type, reference udmf_meta.h.
486 ///
487 /// * `buffer` - Represents a pointer to an instance of [`OH_UdsArrayBuffer`].
488 ///
489 /// # Returns
490 ///
491 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
492 /// [`UDMF_E_OK`] success.
493 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
494 /// [`OH_UdmfRecord`] OH_UdsArrayBuffer Udmf_ErrCode.
495 ///
496 /// Available since API-level: 13
497 #[cfg(feature = "api-13")]
498 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
499 pub fn OH_UdmfRecord_AddArrayBuffer(
500 record: *mut OH_UdmfRecord,
501 type_: *const ::core::ffi::c_char,
502 buffer: *mut OH_UdsArrayBuffer,
503 ) -> ::core::ffi::c_int;
504 /// Add one [`OH_UdsContentForm`] data to the [`OH_UdmfRecord`] record.
505 ///
506 /// # Arguments
507 ///
508 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
509 ///
510 /// * `contentForm` - Represents a pointer to an instance of [`OH_UdsContentForm`].
511 ///
512 /// # Returns
513 ///
514 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
515 /// [`UDMF_E_OK`] success.
516 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
517 /// [`OH_UdmfRecord`] OH_UdsContentForm Udmf_ErrCode.
518 ///
519 /// Available since API-level: 14
520 #[cfg(feature = "api-14")]
521 #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
522 pub fn OH_UdmfRecord_AddContentForm(
523 pThis: *mut OH_UdmfRecord,
524 contentForm: *mut OH_UdsContentForm,
525 ) -> ::core::ffi::c_int;
526 /// Get all types in the [`OH_UdmfRecord`] record.
527 ///
528 /// # Arguments
529 ///
530 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
531 ///
532 /// * `count` - Represents the types count that is a output param.
533 ///
534 /// # Returns
535 ///
536 /// * Returns string array that in [`OH_UdmfRecord`] when input parameters valid,
537 /// otherwise return nullptr.
538 /// [`OH_UdmfRecord.`]
539 /// Available since API-level: 12
540 #[cfg(feature = "api-12")]
541 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
542 pub fn OH_UdmfRecord_GetTypes(
543 pThis: *mut OH_UdmfRecord,
544 count: *mut ::core::ffi::c_uint,
545 ) -> *mut *mut ::core::ffi::c_char;
546 /// Get one entry data from the [`OH_UdmfRecord`] record.
547 ///
548 /// # Arguments
549 ///
550 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
551 ///
552 /// * `typeId` - Represents record type, reference udmf_meta.h.
553 ///
554 /// * `entry` - Represents a pointer to entry data that is a output param.
555 ///
556 /// * `count` - Represents the entry data length that is a output param.
557 ///
558 /// # Returns
559 ///
560 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
561 /// [`UDMF_E_OK`] success.
562 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
563 /// [`UDMF_ERR`] Internal data error.
564 /// [`OH_UdmfRecord`] Udmf_ErrCode.
565 ///
566 /// Available since API-level: 12
567 #[cfg(feature = "api-12")]
568 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
569 pub fn OH_UdmfRecord_GetGeneralEntry(
570 pThis: *mut OH_UdmfRecord,
571 typeId: *const ::core::ffi::c_char,
572 entry: *mut *mut ::core::ffi::c_uchar,
573 count: *mut ::core::ffi::c_uint,
574 ) -> ::core::ffi::c_int;
575 /// Get one {OH_UdsPlainText} data from the [`OH_UdmfRecord`] record.
576 ///
577 /// # Arguments
578 ///
579 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
580 ///
581 /// * `plainText` - Represents a pointer to an instance of [`OH_UdsPlainText`].
582 ///
583 /// # Returns
584 ///
585 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
586 /// [`UDMF_E_OK`] success.
587 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
588 /// [`UDMF_ERR`] Internal data error.
589 /// [`OH_UdmfRecord`] OH_UdsPlainText Udmf_ErrCode.
590 ///
591 /// Available since API-level: 12
592 #[cfg(feature = "api-12")]
593 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
594 pub fn OH_UdmfRecord_GetPlainText(
595 pThis: *mut OH_UdmfRecord,
596 plainText: *mut OH_UdsPlainText,
597 ) -> ::core::ffi::c_int;
598 /// Get one {OH_UdsHyperlink} data from the [`OH_UdmfRecord`] record.
599 ///
600 /// # Arguments
601 ///
602 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
603 ///
604 /// * `hyperlink` - Represents a pointer to an instance of [`OH_UdsHyperlink`].
605 ///
606 /// # Returns
607 ///
608 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
609 /// [`UDMF_E_OK`] success.
610 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
611 /// [`UDMF_ERR`] Internal data error.
612 /// [`OH_UdmfRecord`] OH_UdsHyperlink Udmf_ErrCode.
613 ///
614 /// Available since API-level: 12
615 #[cfg(feature = "api-12")]
616 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
617 pub fn OH_UdmfRecord_GetHyperlink(
618 pThis: *mut OH_UdmfRecord,
619 hyperlink: *mut OH_UdsHyperlink,
620 ) -> ::core::ffi::c_int;
621 /// Get one {OH_UdsHtml} data from the [`OH_UdmfRecord`] record.
622 ///
623 /// # Arguments
624 ///
625 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
626 ///
627 /// * `html` - Represents a pointer to an instance of [`OH_UdsHtml`].
628 ///
629 /// # Returns
630 ///
631 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
632 /// [`UDMF_E_OK`] success.
633 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
634 /// [`UDMF_ERR`] Internal data error.
635 /// [`OH_UdmfRecord`] OH_UdsHtml Udmf_ErrCode.
636 ///
637 /// Available since API-level: 12
638 #[cfg(feature = "api-12")]
639 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
640 pub fn OH_UdmfRecord_GetHtml(
641 pThis: *mut OH_UdmfRecord,
642 html: *mut OH_UdsHtml,
643 ) -> ::core::ffi::c_int;
644 /// Get one {OH_UdsAppItem} data from the [`OH_UdmfRecord`] record.
645 ///
646 /// # Arguments
647 ///
648 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
649 ///
650 /// * `appItem` - Represents a pointer to an instance of [`OH_UdsAppItem`].
651 ///
652 /// # Returns
653 ///
654 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
655 /// [`UDMF_E_OK`] success.
656 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
657 /// [`UDMF_ERR`] Internal data error.
658 /// [`OH_UdmfRecord`] OH_UdsAppItem Udmf_ErrCode.
659 ///
660 /// Available since API-level: 12
661 #[cfg(feature = "api-12")]
662 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
663 pub fn OH_UdmfRecord_GetAppItem(
664 pThis: *mut OH_UdmfRecord,
665 appItem: *mut OH_UdsAppItem,
666 ) -> ::core::ffi::c_int;
667 /// Get one {OH_UdsFileUri} data from the [`OH_UdmfRecord`] record.
668 ///
669 /// # Arguments
670 ///
671 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
672 ///
673 /// * `fileUri` - Represents a pointer to an instance of [`OH_UdsFileUri`].
674 ///
675 /// # Returns
676 ///
677 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
678 /// [`UDMF_E_OK`] success.
679 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
680 /// [`OH_UdmfRecord`] OH_UdsFileUri Udmf_ErrCode.
681 ///
682 /// Available since API-level: 13
683 #[cfg(feature = "api-13")]
684 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
685 pub fn OH_UdmfRecord_GetFileUri(
686 pThis: *mut OH_UdmfRecord,
687 fileUri: *mut OH_UdsFileUri,
688 ) -> ::core::ffi::c_int;
689 /// Get one {OH_UdsPixelMap} data from the [`OH_UdmfRecord`] record.
690 ///
691 /// # Arguments
692 ///
693 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
694 ///
695 /// * `pixelMap` - Represents a pointer to an instance of [`OH_UdsPixelMap`].
696 ///
697 /// # Returns
698 ///
699 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
700 /// [`UDMF_E_OK`] success.
701 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
702 /// [`OH_UdmfRecord`] OH_UdsPixelMap Udmf_ErrCode.
703 ///
704 /// Available since API-level: 13
705 #[cfg(feature = "api-13")]
706 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
707 pub fn OH_UdmfRecord_GetPixelMap(
708 pThis: *mut OH_UdmfRecord,
709 pixelMap: *mut OH_UdsPixelMap,
710 ) -> ::core::ffi::c_int;
711 /// Set the data provider of the types.
712 ///
713 /// # Arguments
714 ///
715 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
716 ///
717 /// * `types` - Represents a pointer to a group of data types;
718 ///
719 /// * `count` - Represents the number of data types;
720 ///
721 /// * `provider` - Represents a pointer an instance of [`OH_UdmfRecordProvider`].
722 ///
723 /// # Returns
724 ///
725 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
726 /// [`UDMF_E_OK`] success.
727 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
728 /// [`OH_UdmfRecord`] OH_UdmfRecordProvider Udmf_ErrCode.
729 ///
730 /// Available since API-level: 13
731 #[cfg(feature = "api-13")]
732 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
733 pub fn OH_UdmfRecord_SetProvider(
734 pThis: *mut OH_UdmfRecord,
735 types: *const *const ::core::ffi::c_char,
736 count: ::core::ffi::c_uint,
737 provider: *mut OH_UdmfRecordProvider,
738 ) -> ::core::ffi::c_int;
739 /// Get one [`OH_UdsArrayBuffer`] data from the [`OH_UdmfRecord`] record.
740 ///
741 /// # Arguments
742 ///
743 /// * `record` - Represents a pointer to an instance of [`OH_UdmfRecord`].
744 ///
745 /// * `type` - Represents record type, reference udmf_meta.h.
746 ///
747 /// * `buffer` - Represents a pointer to an instance of [`OH_UdsArrayBuffer`].
748 ///
749 /// # Returns
750 ///
751 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
752 /// [`UDMF_E_OK`] success.
753 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
754 /// [`OH_UdmfRecord`] OH_UdsArrayBuffer Udmf_ErrCode.
755 ///
756 /// Available since API-level: 13
757 #[cfg(feature = "api-13")]
758 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
759 pub fn OH_UdmfRecord_GetArrayBuffer(
760 record: *mut OH_UdmfRecord,
761 type_: *const ::core::ffi::c_char,
762 buffer: *mut OH_UdsArrayBuffer,
763 ) -> ::core::ffi::c_int;
764 /// Get one [`OH_UdsContentForm`] data from the [`OH_UdmfRecord`] record.
765 ///
766 /// # Arguments
767 ///
768 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfRecord`].
769 ///
770 /// * `contentForm` - Represents a pointer to an instance of [`OH_UdsContentForm`].
771 ///
772 /// # Returns
773 ///
774 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
775 /// [`UDMF_E_OK`] success.
776 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
777 /// [`OH_UdmfRecord`] OH_UdsContentForm Udmf_ErrCode.
778 ///
779 /// Available since API-level: 14
780 #[cfg(feature = "api-14")]
781 #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
782 pub fn OH_UdmfRecord_GetContentForm(
783 pThis: *mut OH_UdmfRecord,
784 contentForm: *mut OH_UdsContentForm,
785 ) -> ::core::ffi::c_int;
786 /// Get primary [`OH_UdsPlainText`] data from the [`OH_UdmfData`].
787 ///
788 /// # Arguments
789 ///
790 /// * `data` - Represents a pointer to an instance of [`OH_UdmfData`].
791 ///
792 /// * `plainText` - Represents a pointer to an instance of [`OH_UdsPlainText`].
793 ///
794 /// # Returns
795 ///
796 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
797 /// [`UDMF_E_OK`] success.
798 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
799 /// [`OH_UdmfData`] OH_UdsPlainText Udmf_ErrCode.
800 ///
801 /// Available since API-level: 13
802 #[cfg(feature = "api-13")]
803 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
804 pub fn OH_UdmfData_GetPrimaryPlainText(
805 data: *mut OH_UdmfData,
806 plainText: *mut OH_UdsPlainText,
807 ) -> ::core::ffi::c_int;
808 /// Get one [`OH_UdsHtml`] data from the [`OH_UdmfData`].
809 ///
810 /// # Arguments
811 ///
812 /// * `data` - Represents a pointer to an instance of [`OH_UdmfData`].
813 ///
814 /// * `html` - Represents a pointer to an instance of [`OH_UdsHtml`].
815 ///
816 /// # Returns
817 ///
818 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
819 /// [`UDMF_E_OK`] success.
820 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
821 /// [`OH_UdmfData`] OH_UdsHtml Udmf_ErrCode.
822 ///
823 /// Available since API-level: 13
824 #[cfg(feature = "api-13")]
825 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
826 pub fn OH_UdmfData_GetPrimaryHtml(
827 data: *mut OH_UdmfData,
828 html: *mut OH_UdsHtml,
829 ) -> ::core::ffi::c_int;
830 /// Get the count of [`OH_UdmfRecord`] in the [`OH_UdmfData`].
831 ///
832 /// # Arguments
833 ///
834 /// * `data` - Represents a pointer to an instance of [`OH_UdmfData`].
835 ///
836 /// # Returns
837 ///
838 /// * Returns the count of [`OH_UdmfRecord`]
839 /// [`OH_UdmfData.`]
840 /// Available since API-level: 13
841 #[cfg(feature = "api-13")]
842 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
843 pub fn OH_UdmfData_GetRecordCount(data: *mut OH_UdmfData) -> ::core::ffi::c_int;
844 /// Get the record of the specified index from the [`OH_UdmfData`].
845 ///
846 /// # Arguments
847 ///
848 /// * `data` - Represents a pointer to an instance of [`OH_UdmfData`].
849 ///
850 /// * `index` - Represents the index of [`OH_UdmfRecord`] in the [`OH_UdmfData`].
851 ///
852 /// # Returns
853 ///
854 /// * Returns [`OH_UdmfRecord`] pointer when input parameters valid, otherwise return nullptr.
855 /// [`OH_UdmfData.`]
856 /// Available since API-level: 13
857 #[cfg(feature = "api-13")]
858 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
859 pub fn OH_UdmfData_GetRecord(
860 data: *mut OH_UdmfData,
861 index: ::core::ffi::c_uint,
862 ) -> *mut OH_UdmfRecord;
863 /// Checks whether the UDMF data is from a local device.
864 ///
865 /// # Arguments
866 ///
867 /// * `data` - Represents a pointer to an instance of [`OH_UdmfData`].
868 ///
869 /// # Returns
870 ///
871 /// * Returns a boolean value, which indicates whether the UDMF data is from a local device.
872 /// The value `true` means the data is from a local device.
873 /// The value `false` means the opposite.
874 /// [`OH_UdmfData.`]
875 /// Available since API-level: 13
876 #[cfg(feature = "api-13")]
877 #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
878 pub fn OH_UdmfData_IsLocal(data: *mut OH_UdmfData) -> bool;
879 /// Creation a pointer to the instance of the [`OH_UdmfProperty`]
880 /// from a [`OH_UdmfData`] data.
881 ///
882 /// # Arguments
883 ///
884 /// * `unifiedData` - Represents a pointer to an instance of [`OH_UdmfData`].
885 ///
886 /// # Returns
887 ///
888 /// * If the operation is successful, a pointer to the instance of the [`OH_UdmfProperty`]
889 /// structure is returned. If the operation is failed, nullptr is returned.
890 /// [`OH_UdmfData`] OH_UdmfProperty.
891 ///
892 /// Available since API-level: 12
893 #[cfg(feature = "api-12")]
894 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
895 pub fn OH_UdmfProperty_Create(unifiedData: *mut OH_UdmfData) -> *mut OH_UdmfProperty;
896 /// Destroy a pointer that points to the [`OH_UdmfProperty`] instance.
897 ///
898 /// # Arguments
899 ///
900 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
901 /// [`OH_UdmfProperty.`]
902 /// Available since API-level: 12
903 #[cfg(feature = "api-12")]
904 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
905 pub fn OH_UdmfProperty_Destroy(pThis: *mut OH_UdmfProperty);
906 /// Get tag value from the [`OH_UdmfProperty`].
907 ///
908 /// # Arguments
909 ///
910 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
911 ///
912 /// # Returns
913 ///
914 /// * Returns a pointer of the tag value string when input parameters valid, otherwise return nullptr.
915 /// [`OH_UdmfProperty.`]
916 /// Available since API-level: 12
917 #[cfg(feature = "api-12")]
918 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
919 pub fn OH_UdmfProperty_GetTag(pThis: *mut OH_UdmfProperty) -> *const ::core::ffi::c_char;
920 /// Get timestamp value from the [`OH_UdmfProperty`].
921 ///
922 /// # Arguments
923 ///
924 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
925 ///
926 /// # Returns
927 ///
928 /// * Returns timestamp value.
929 /// [`OH_UdmfProperty`]
930 /// Available since API-level: 12
931 #[cfg(feature = "api-12")]
932 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
933 pub fn OH_UdmfProperty_GetTimestamp(pThis: *mut OH_UdmfProperty) -> i64;
934 /// Get share option value from the [`OH_UdmfProperty`].
935 ///
936 /// # Arguments
937 ///
938 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
939 ///
940 /// # Returns
941 ///
942 /// * Returns [`Udmf_ShareOption`] value.
943 /// [`OH_UdmfProperty`] Udmf_ShareOption
944 ///
945 /// Available since API-level: 12
946 #[cfg(feature = "api-12")]
947 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
948 pub fn OH_UdmfProperty_GetShareOption(pThis: *mut OH_UdmfProperty) -> Udmf_ShareOption;
949 /// Get integer value by key from the [`OH_UdmfProperty`].
950 ///
951 /// # Arguments
952 ///
953 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
954 ///
955 /// * `key` - Represents key-value pair's key
956 ///
957 /// * `defaultValue` - Represents when get value failure.
958 ///
959 /// # Returns
960 ///
961 /// * Returns value associated with the key in successfully, otherwise return defaultValue.
962 /// [`OH_UdmfProperty.`]
963 /// Available since API-level: 12
964 #[cfg(feature = "api-12")]
965 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
966 pub fn OH_UdmfProperty_GetExtrasIntParam(
967 pThis: *mut OH_UdmfProperty,
968 key: *const ::core::ffi::c_char,
969 defaultValue: ::core::ffi::c_int,
970 ) -> ::core::ffi::c_int;
971 /// Get tag value from the [`OH_UdmfProperty`].
972 ///
973 /// # Arguments
974 ///
975 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
976 ///
977 /// * `key` - Represents key-value pair's key.
978 ///
979 /// # Returns
980 ///
981 /// * Returns a pointer of the key value string when input parameters valid, otherwise return nullptr.
982 /// [`OH_UdmfProperty`]
983 /// Available since API-level: 12
984 #[cfg(feature = "api-12")]
985 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
986 pub fn OH_UdmfProperty_GetExtrasStringParam(
987 pThis: *mut OH_UdmfProperty,
988 key: *const ::core::ffi::c_char,
989 ) -> *const ::core::ffi::c_char;
990 /// Set tag value to [`OH_UdmfProperty`] .
991 ///
992 /// # Arguments
993 ///
994 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
995 ///
996 /// * `tag` - Represents new tag param.
997 ///
998 /// # Returns
999 ///
1000 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1001 /// [`UDMF_E_OK`] success.
1002 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1003 /// [`OH_UdmfProperty`] Udmf_ErrCode.
1004 ///
1005 /// Available since API-level: 12
1006 #[cfg(feature = "api-12")]
1007 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1008 pub fn OH_UdmfProperty_SetTag(
1009 pThis: *mut OH_UdmfProperty,
1010 tag: *const ::core::ffi::c_char,
1011 ) -> ::core::ffi::c_int;
1012 /// Set Udmf_ShareOption value to [`OH_UdmfProperty`].
1013 ///
1014 /// # Arguments
1015 ///
1016 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
1017 ///
1018 /// * `option` - Represents new [`Udmf_ShareOption`] param.
1019 ///
1020 /// # Returns
1021 ///
1022 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1023 /// [`UDMF_E_OK`] success.
1024 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1025 /// [`OH_UdmfProperty`] Udmf_ShareOption Udmf_ErrCode.
1026 ///
1027 /// Available since API-level: 12
1028 #[cfg(feature = "api-12")]
1029 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1030 pub fn OH_UdmfProperty_SetShareOption(
1031 pThis: *mut OH_UdmfProperty,
1032 option: Udmf_ShareOption,
1033 ) -> ::core::ffi::c_int;
1034 /// Set extras param to [`OH_UdmfProperty`].
1035 ///
1036 /// # Arguments
1037 ///
1038 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
1039 ///
1040 /// * `key` - Represents extras param's key value.
1041 ///
1042 /// * `param` - Represents value of k-v pairs.
1043 ///
1044 /// # Returns
1045 ///
1046 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1047 /// [`UDMF_E_OK`] success.
1048 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1049 /// [`OH_UdmfProperty`] Udmf_ErrCode.
1050 ///
1051 /// Available since API-level: 12
1052 #[cfg(feature = "api-12")]
1053 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1054 pub fn OH_UdmfProperty_SetExtrasIntParam(
1055 pThis: *mut OH_UdmfProperty,
1056 key: *const ::core::ffi::c_char,
1057 param: ::core::ffi::c_int,
1058 ) -> ::core::ffi::c_int;
1059 /// Set extras param to [`OH_UdmfProperty`].
1060 ///
1061 /// # Arguments
1062 ///
1063 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfProperty`].
1064 ///
1065 /// * `key` - Represents extras param's key value.
1066 ///
1067 /// * `param` - Represents value of k-v pairs.
1068 ///
1069 /// # Returns
1070 ///
1071 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1072 /// [`UDMF_E_OK`] success.
1073 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1074 /// [`OH_UdmfProperty`] Udmf_ErrCode.
1075 ///
1076 /// Available since API-level: 12
1077 #[cfg(feature = "api-12")]
1078 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1079 pub fn OH_UdmfProperty_SetExtrasStringParam(
1080 pThis: *mut OH_UdmfProperty,
1081 key: *const ::core::ffi::c_char,
1082 param: *const ::core::ffi::c_char,
1083 ) -> ::core::ffi::c_int;
1084 /// Get [`OH_UdmfData`] data from udmf database.
1085 ///
1086 /// # Arguments
1087 ///
1088 /// * `key` - Represents database store's key value.
1089 ///
1090 /// * `intention` - Represents data type [`Udmf_Intention`]
1091 ///
1092 /// * `unifiedData` - Represents output params of [`OH_UdmfData`];
1093 ///
1094 /// # Returns
1095 ///
1096 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1097 /// [`UDMF_E_OK`] success.
1098 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1099 /// [`UDMF_ERR`] Internal data error.
1100 /// [`OH_UdmfProperty`] Udmf_Intention Udmf_ErrCode.
1101 ///
1102 /// Available since API-level: 12
1103 #[cfg(feature = "api-12")]
1104 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1105 pub fn OH_Udmf_GetUnifiedData(
1106 key: *const ::core::ffi::c_char,
1107 intention: Udmf_Intention,
1108 unifiedData: *mut OH_UdmfData,
1109 ) -> ::core::ffi::c_int;
1110 /// Set [`OH_UdmfData`] data to database.
1111 ///
1112 /// # Arguments
1113 ///
1114 /// * `intention` - Represents data type [`Udmf_Intention`].
1115 ///
1116 /// * `unifiedData` - Represents a pointer to an instance of [`OH_UdmfData`].
1117 ///
1118 /// * `key` - Represents return value after set data to database successfully,
1119 /// it's memory size not less than [`UDMF_KEY_BUFFER_LEN`].
1120 ///
1121 /// * `keyLen` - Represents size of key param.
1122 ///
1123 /// # Returns
1124 ///
1125 /// * Returns the status code of the execution. See [`Udmf_ErrCode`].
1126 /// [`UDMF_E_OK`] success.
1127 /// [`UDMF_E_INVALID_PARAM`] The error code for common invalid args.
1128 /// [`UDMF_ERR`] Internal data error.
1129 /// [`OH_UdmfProperty`] Udmf_Intention Udmf_ErrCode.
1130 ///
1131 /// Available since API-level: 12
1132 #[cfg(feature = "api-12")]
1133 #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
1134 pub fn OH_Udmf_SetUnifiedData(
1135 intention: Udmf_Intention,
1136 unifiedData: *mut OH_UdmfData,
1137 key: *mut ::core::ffi::c_char,
1138 keyLen: ::core::ffi::c_uint,
1139 ) -> ::core::ffi::c_int;
1140 /// Gets the progress from the [`OH_Udmf_ProgressInfo`].
1141 ///
1142 /// # Arguments
1143 ///
1144 /// * `progressInfo` - Represents a pointer to an instance of [`OH_Udmf_ProgressInfo`].
1145 ///
1146 /// # Returns
1147 ///
1148 /// * Returns the progress.
1149 /// [`OH_Udmf_ProgressInfo`]
1150 /// Available since API-level: 15
1151 #[cfg(feature = "api-15")]
1152 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1153 pub fn OH_UdmfProgressInfo_GetProgress(
1154 progressInfo: *mut OH_Udmf_ProgressInfo,
1155 ) -> ::core::ffi::c_int;
1156 /// Gets the status from the [`OH_Udmf_ProgressInfo`].
1157 ///
1158 /// # Arguments
1159 ///
1160 /// * `progressInfo` - Represents a pointer to an instance of [`OH_Udmf_ProgressInfo`].
1161 ///
1162 /// # Returns
1163 ///
1164 /// * Returns the status code. See [`Udmf_ListenerStatus`].
1165 /// [`OH_Udmf_ProgressInfo`] Udmf_ListenerStatus
1166 ///
1167 /// Available since API-level: 15
1168 #[cfg(feature = "api-15")]
1169 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1170 pub fn OH_UdmfProgressInfo_GetStatus(
1171 progressInfo: *mut OH_Udmf_ProgressInfo,
1172 ) -> ::core::ffi::c_int;
1173 /// Creation a pointer to the instance of the [`OH_UdmfGetDataParams`].
1174 ///
1175 ///
1176 /// # Returns
1177 ///
1178 /// * If the operation is successful, a pointer to the instance of the [`OH_UdmfGetDataParams`]
1179 /// structure is returned. If the operation is failed, nullptr is returned.
1180 /// [`OH_UdmfGetDataParams`]
1181 /// Available since API-level: 15
1182 #[cfg(feature = "api-15")]
1183 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1184 pub fn OH_UdmfGetDataParams_Create() -> *mut OH_UdmfGetDataParams;
1185 /// Destroy a pointer that points to an instance of [`OH_UdmfGetDataParams`].
1186 ///
1187 /// # Arguments
1188 ///
1189 /// * `pThis` - Represents a pointer to an instance of [`OH_UdmfGetDataParams`].
1190 /// [`OH_UdmfGetDataParams`]
1191 /// Available since API-level: 15
1192 #[cfg(feature = "api-15")]
1193 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1194 pub fn OH_UdmfGetDataParams_Destroy(pThis: *mut OH_UdmfGetDataParams);
1195 /// Sets the destination uri to the [`OH_UdmfGetDataParams`].
1196 ///
1197 /// # Arguments
1198 ///
1199 /// * `params` - Represents a pointer to an instance of [`OH_UdmfGetDataParams`].
1200 ///
1201 /// * `destUri` - Pointer to a destination uri.
1202 /// [`OH_UdmfGetDataParams`]
1203 /// Available since API-level: 15
1204 #[cfg(feature = "api-15")]
1205 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1206 pub fn OH_UdmfGetDataParams_SetDestUri(
1207 params: *mut OH_UdmfGetDataParams,
1208 destUri: *const ::core::ffi::c_char,
1209 );
1210 /// Sets the file conflict options to the [`OH_UdmfGetDataParams`].
1211 ///
1212 /// # Arguments
1213 ///
1214 /// * `params` - Represents a pointer to an instance of [`OH_UdmfGetDataParams`].
1215 ///
1216 /// * `options` - Represents to the file conflict options.
1217 /// [`OH_UdmfGetDataParams`] Udmf_FileConflictOptions
1218 ///
1219 /// Available since API-level: 15
1220 #[cfg(feature = "api-15")]
1221 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1222 pub fn OH_UdmfGetDataParams_SetFileConflictOptions(
1223 params: *mut OH_UdmfGetDataParams,
1224 options: Udmf_FileConflictOptions,
1225 );
1226 /// Sets the progress indicator to the [`OH_UdmfGetDataParams`].
1227 ///
1228 /// # Arguments
1229 ///
1230 /// * `params` - Represents a pointer to an instance of [`OH_UdmfGetDataParams`].
1231 ///
1232 /// * `progressIndicator` - Represents to the progress indicator.
1233 /// [`OH_UdmfGetDataParams`] Udmf_ProgressIndicator
1234 ///
1235 /// Available since API-level: 15
1236 #[cfg(feature = "api-15")]
1237 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1238 pub fn OH_UdmfGetDataParams_SetProgressIndicator(
1239 params: *mut OH_UdmfGetDataParams,
1240 progressIndicator: Udmf_ProgressIndicator,
1241 );
1242 /// Sets the progress indicator to the [`OH_UdmfGetDataParams`].
1243 ///
1244 /// # Arguments
1245 ///
1246 /// * `params` - Represents a pointer to an instance of [`OH_UdmfGetDataParams`].
1247 ///
1248 /// * `dataProgressListener` - Represents to the data progress listener.
1249 /// [`OH_UdmfGetDataParams`] OH_Udmf_DataProgressListener
1250 ///
1251 /// Available since API-level: 15
1252 #[cfg(feature = "api-15")]
1253 #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
1254 pub fn OH_UdmfGetDataParams_SetDataProgressListener(
1255 params: *mut OH_UdmfGetDataParams,
1256 dataProgressListener: OH_Udmf_DataProgressListener,
1257 );
1258}