• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# UDMF
2
3
4## Overview
5
6The Unified Data Management Framework (UDMF) defines standards for data management across applications, devices, and platforms, and provides a unified OpenHarmony data language and standard data access channels.
7
8**Since**: 12
9
10**System capability**: SystemCapability.DistributedDataManager.UDMF.Core
11
12
13## Summary
14
15
16### Files
17
18| Name| Description|
19| -------- | -------- |
20| [udmf.h](udmf_8h.md) | Defines the APIs, data structs, and enums for accessing the UDMF. <br/>File to include: &lt;database/udmf/udmf.h&gt; |
21| [udmf_err_code.h](udmf__err__code_8h.md) | Declares the error codes used in the UDMF. <br/>File to include: &lt;database/udmf/udmf_err_code.h&gt; |
22| [udmf_meta.h](udmf__meta_8h.md) | Declares the uniform data types. <br/>File to include: &lt;database/udmf/udmf_meta.h&gt; |
23| [uds.h](uds_8h.md) | Defines the APIs and structs related to the uniform data structs. <br/>File to include: &lt;database/udmf/uds.h&gt; |
24| [utd.h](utd_8h.md) | Defines APIs and structs related to the Uniform Type Descriptors (UTDs). <br/>File to include: &lt;database/udmf/utd.h&gt; |
25
26
27### Macros
28
29| Name| Description|
30| -------- | -------- |
31| [UDMF_KEY_BUFFER_LEN](#udmf_key_buffer_len)   (512) | Minimum length of the buffer that holds the key (unique identifier) of a uniform data object.|
32| [UDMF_META_ENTITY](#udmf_meta_entity)   "general.entity" | Generic type that represents all physical storage types. It is used to define physical properties of a type.<br>This type is uncategorized.|
33| [UDMF_META_OBJECT](#udmf_meta_object)   "general.object" | Generic type that represents all logical content types. It is used to define physical properties of a type.<br>This type is uncategorized.|
34| [UDMF_META_COMPOSITE_OBJECT](#udmf_meta_composite_object)   "general.composite-object" | Generic composite content type. For example, a PDF file that contains text and image.<br>This type belongs to **OBJECT**.|
35| [UDMF_META_TEXT](#udmf_meta_text)   "general.text" | Generic text type.<br>This type belongs to **OBJECT**.|
36| [UDMF_META_PLAIN_TEXT](#udmf_meta_plain_text)   "general.plain-text" | Text without specific encoding or identifier.<br>This type belongs to **TEXT**.|
37| [UDMF_META_HTML](#udmf_meta_html)   "general.html" | HTML.<br>This type belongs to **TEXT**.|
38| [UDMF_META_HYPERLINK](#udmf_meta_hyperlink)   "general.hyperlink" | Hyperlink.<br>This type belongs to **TEXT**.|
39| [UDMF_META_XML](#udmf_meta_xml)   "general.xml" | XML.<br>This type belongs to **TEXT**.|
40| [UDMF_META_SOURCE_CODE](#udmf_meta_source_code)   "general.source-code" | Generic source code type.<br>This type belongs to **PLAIN_TEXT**.|
41| [UDMF_META_SCRIPT](#udmf_meta_script)   "general.script" | Source code in any scripting language.<br>This type belongs to **SOURCE_CODE**.|
42| [UDMF_META_SHELL_SCRIPT](#udmf_meta_shell_script)   "general.shell-script" | Shell script.<br>This type belongs to **SCRIPT**.|
43| [UDMF_META_CSH_SCRIPT](#udmf_meta_csh_script)   "general.csh-script" | C shell script.<br>This type belongs to **SHELL_SCRIPT**.|
44| [UDMF_META_PERL_SCRIPT](#udmf_meta_perl_script)   "general.perl-script" | Perl script.<br>This type belongs to **SHELL_SCRIPT**.|
45| [UDMF_META_PHP_SCRIPT](#udmf_meta_php_script)   "general.php-script" | PHP script.<br>This type belongs to **SHELL_SCRIPT**.|
46| [UDMF_META_PYTHON_SCRIPT](#udmf_meta_python_script)   "general.python-script" | Python script.<br>This type belongs to **SHELL_SCRIPT**.|
47| [UDMF_META_RUBY_SCRIPT](#udmf_meta_ruby_script)   "general.ruby-script" | Ruby script.<br>This type belongs to **SHELL_SCRIPT**.|
48| [UDMF_META_TYPE_SCRIPT](#udmf_meta_type_script)   "general.type-script" | TypeScript source code.<br>This type belongs to **SCRIPT**.|
49| [UDMF_META_JAVA_SCRIPT](#udmf_meta_java_script)   "general.java-script" | JavaScript source code.<br>This type belongs to **SCRIPT**.|
50| [UDMF_META_C_HEADER](#udmf_meta_c_header)   "general.c-header" | Header file in C.<br>This type belongs to **SOURCE_CODE**.|
51| [UDMF_META_C_SOURCE](#udmf_meta_c_source)   "general.c-source" | Source code in C.<br>This type belongs to **SOURCE_CODE**.|
52| [UDMF_META_C_PLUS_PLUS_HEADER](#udmf_meta_c_plus_plus_header)   "general.c-plus-plus-header" | Header file in C++.<br>This type belongs to **SOURCE_CODE**.|
53| [UDMF_META_C_PLUS_PLUS_SOURCE](#udmf_meta_c_plus_plus_source)   "general.c-plus-plus-source" | Source code in C++.<br>This type belongs to **SOURCE_CODE**.|
54| [UDMF_META_JAVA_SOURCE](#udmf_meta_java_source)   "general.java-source" | Source code in Java.<br>This type belongs to **SOURCE_CODE**.|
55| [UDMF_META_EBOOK](#udmf_meta_ebook)   "general.ebook" | Generic eBook file format type.<br>This type belongs to **COMPOSITE_OBJECT**.|
56| [UDMF_META_EPUB](#udmf_meta_epub)   "general.epub" | Electronic publication (EPUB).<br>This type belongs to **EBOOK**.|
57| [UDMF_META_AZW](#udmf_meta_azw)   "com.amazon.azw" | AZW.<br>This type belongs to **EBOOK**.|
58| [UDMF_META_AZW3](#udmf_meta_azw3)   "com.amazon.azw3" | AZW3.<br>This type belongs to **EBOOK**.|
59| [UDMF_META_KFX](#udmf_meta_kfx)   "com.amazon.kfx" | KFX.<br>This type belongs to **EBOOK**.|
60| [UDMF_META_MOBI](#udmf_meta_mobi)   "com.amazon.mobi" | MOBI.<br>This type belongs to **EBOOK**.|
61| [UDMF_META_MEDIA](#udmf_meta_media)   "general.media" | Generic media type.<br>This type belongs to **OBJECT**.|
62| [UDMF_META_IMAGE](#udmf_meta_image)   "general.image" | Image.<br>This type belongs to **MEDIA**.|
63| [UDMF_META_JPEG](#udmf_meta_jpeg)   "general.jpeg" | JPEG.<br>This type belongs to **IMAGE**.|
64| [UDMF_META_PNG](#udmf_meta_png)   "general.png" | PNG.<br>This type belongs to **IMAGE**.|
65| [UDMF_META_RAW_IMAGE](#udmf_meta_raw_image)   "general.raw-image" | Raw image.<br>This type belongs to **IMAGE**.|
66| [UDMF_META_TIFF](#udmf_meta_tiff)   "general.tiff" | TIFF.<br>This type belongs to **IMAGE**.|
67| [UDMF_META_BMP](#udmf_meta_bmp)   "com.microsoft.bmp" | BMP.<br>This type belongs to **IMAGE**.|
68| [UDMF_META_ICO](#udmf_meta_ico)   "com.microsoft.ico" | Windows icon.<br>This type belongs to **IMAGE**.|
69| [UDMF_META_PHOTOSHOP_IMAGE](#udmf_meta_photoshop_image)   "com.adobe.photoshop-image" | Adobe Photoshop image.<br>This type belongs to **IMAGE**.|
70| [UDMF_META_AI_IMAGE](#udmf_meta_ai_image)   "com.adobe.illustrator.ai-image" | Adobe Illustrator image (.ai).<br>This type belongs to **IMAGE**.|
71| [UDMF_META_WORD_DOC](#udmf_meta_word_doc)   "com.microsoft.word.doc" | Microsoft Word.<br>This type belongs to **COMPOSITE_OBJECT**.|
72| [UDMF_META_EXCEL](#udmf_meta_excel)   "com.microsoft.excel.xls" | Microsoft Excel.<br>This type belongs to **COMPOSITE_OBJECT**.|
73| [UDMF_META_PPT](#udmf_meta_ppt)   "com.microsoft.powerpoint.ppt" | Microsoft PowerPoint presentation format.<br>This type belongs to **COMPOSITE_OBJECT**.|
74| [UDMF_META_PDF](#udmf_meta_pdf)   "com.adobe.pdf" | PDF.<br>This type belongs to **COMPOSITE_OBJECT**.|
75| [UDMF_META_POSTSCRIPT](#udmf_meta_postscript)   "com.adobe.postscript" | PostScript.<br>This type belongs to **COMPOSITE_OBJECT**.|
76| [UDMF_META_ENCAPSULATED_POSTSCRIPT](#udmf_meta_encapsulated_postscript)   "com.adobe.encapsulated-postscript" | Encapsulated PostScript.<br>This type belongs to **POSTSCRIPT**.|
77| [UDMF_META_VIDEO](#udmf_meta_video)   "general.video" | Generic video type.<br>This type belongs to **MEDIA**.|
78| [UDMF_META_AVI](#udmf_meta_avi)   "general.avi" | AVI.<br>This type belongs to **VIDEO**.|
79| [UDMF_META_MPEG](#udmf_meta_mpeg)   "general.mpeg" | MPGE-1 or MPGE-2.<br>This type belongs to **VIDEO**.|
80| [UDMF_META_MPEG4](#udmf_meta_mpeg4)   "general.mpeg-4" | MPGE-4.<br>This type belongs to **VIDEO**.|
81| [UDMF_META_VIDEO_3GPP](#udmf_meta_video_3gpp)   "general.3gpp" | 3GP (3GPP file format).<br>This type belongs to **VIDEO**.|
82| [UDMF_META_VIDEO_3GPP2](#udmf_meta_video_3gpp2)   "general.3gpp2" | 3G2 (3GPP2 file format).<br>This type belongs to **VIDEO**.|
83| [UDMF_META_WINDOWS_MEDIA_WM](#udmf_meta_windows_media_wm)   "com.microsoft.windows-media-wm" | Windows WM format.<br>This type belongs to **VIDEO**.|
84| [UDMF_META_WINDOWS_MEDIA_WMV](#udmf_meta_windows_media_wmv)   "com.microsoft.windows-media-wmv" | Windows WMV format.<br>This type belongs to **VIDEO**.|
85| [UDMF_META_WINDOWS_MEDIA_WMP](#udmf_meta_windows_media_wmp)   "com.microsoft.windows-media-wmp" | Windows WMP format.<br>This type belongs to **VIDEO**.|
86| [UDMF_META_AUDIO](#udmf_meta_audio)   "general.audio" | Generic audio type.<br>This type belongs to **MEDIA**.|
87| [UDMF_META_AAC](#udmf_meta_aac)   "general.aac" | AAC.<br>This type belongs to **AUDIO**.|
88| [UDMF_META_AIFF](#udmf_meta_aiff)   "general.aiff" | AIFF.<br>This type belongs to **AUDIO**.|
89| [UDMF_META_ALAC](#udmf_meta_alac)   "general.alac" | ALAC.<br>This type belongs to **AUDIO**.|
90| [UDMF_META_FLAC](#udmf_meta_flac)   "general.flac" | FLAC.<br>This type belongs to **AUDIO**.|
91| [UDMF_META_MP3](#udmf_meta_mp3)   "general.mp3" | MP3.<br>This type belongs to **AUDIO**.|
92| [UDMF_META_OGG](#udmf_meta_ogg)   "general.ogg" | OGG.<br>This type belongs to **AUDIO**.|
93| [UDMF_META_PCM](#udmf_meta_pcm)   "general.pcm" | PCM.<br>This type belongs to **AUDIO**.|
94| [UDMF_META_WINDOWS_MEDIA_WMA](#udmf_meta_windows_media_wma)   "com.microsoft.windows-media-wma" | Windows WMA.<br>This type belongs to **AUDIO**.|
95| [UDMF_META_WAVEFORM_AUDIO](#udmf_meta_waveform_audio)   "com.microsoft.waveform-audio" | Windows Waveform.<br>This type belongs to **AUDIO**.|
96| [UDMF_META_WINDOWS_MEDIA_WMX](#udmf_meta_windows_media_wmx)   "com.microsoft.windows-media-wmx" | Windows WMX format.<br>This type belongs to **VIDEO**.|
97| [UDMF_META_WINDOWS_MEDIA_WVX](#udmf_meta_windows_media_wvx)   "com.microsoft.windows-media-wvx" | Windows WVX format.<br>This type belongs to **VIDEO**.|
98| [UDMF_META_WINDOWS_MEDIA_WAX](#udmf_meta_windows_media_wax)   "com.microsoft.windows-media-wax" | Windows WAX.<br>This type belongs to **AUDIO**.|
99| [UDMF_META_GENERAL_FILE](#udmf_meta_general_file)   "general.file" | Generic file type.<br>This type belongs to **ENTITY**.|
100| [UDMF_META_DIRECTORY](#udmf_meta_directory)   "general.directory" | Generic directory type.<br>This type belongs to **ENTITY**.|
101| [UDMF_META_FOLDER](#udmf_meta_folder)   "general.folder" | Generic folder type.<br>This type belongs to **DIRECTORY**.|
102| [UDMF_META_SYMLINK](#udmf_meta_symlink)   "general.symlink" | Generic symbolic type.<br>This type belongs to **ENTITY**.|
103| [UDMF_META_ARCHIVE](#udmf_meta_archive)   "general.archive" | Generic archive file type.<br>This type belongs to **OBJECT**.|
104| [UDMF_META_BZ2_ARCHIVE](#udmf_meta_bz2_archive)   "general.bz2-archive" | BZ2.<br>This type belongs to **ARCHIVE**.|
105| [UDMF_META_DISK_IMAGE](#udmf_meta_disk_image)   "general.disk-image" | Generic type of any file that can be mounted as a volume.<br>This type belongs to **ARCHIVE**.|
106| [UDMF_META_TAR_ARCHIVE](#udmf_meta_tar_archive)   "general.tar-archive" | TAR.<br>This type belongs to ARCHIVE.|
107| [UDMF_META_ZIP_ARCHIVE](#udmf_meta_zip_archive)   "general.zip-archive" | ZIP.<br>This type belongs to **ARCHIVE**.|
108| [UDMF_META_JAVA_ARCHIVE](#udmf_meta_java_archive)   "com.sun.java-archive" | JAR (Java archive).<br>This type belongs to **ARCHIVE** and **EXECUTABLE**.|
109| [UDMF_META_GNU_TAR_ARCHIVE](#udmf_meta_gnu_tar_archive)   "org.gnu.gnu-tar-archive" | GUN archive.<br>This type belongs to **ARCHIVE**.|
110| [UDMF_META_GNU_ZIP_ARCHIVE](#udmf_meta_gnu_zip_archive)   "org.gnu.gnu-zip-archive" | GZIP archive.<br>This type belongs to **ARCHIVE**.|
111| [UDMF_META_GNU_ZIP_TAR_ARCHIVE](#udmf_meta_gnu_zip_tar_archive)   "org.gnu.gnu-zip-tar-archive" | GZIP TAR.<br>This type belongs to **ARCHIVE**.|
112| [UDMF_META_CALENDAR](#udmf_meta_calendar)   "general.calendar" | Generic calendar type.<br>This type belongs to **OBJECT**.|
113| [UDMF_META_CONTACT](#udmf_meta_contact)   "general.contact" | Generic contact type.<br>This type belongs to **OBJECT**.|
114| [UDMF_META_DATABASE](#udmf_meta_database)   "general.database" | Generic database file type.<br>This type belongs to **OBJECT**.|
115| [UDMF_META_MESSAGE](#udmf_meta_message)   "general.message" | Generic message type.<br>This type belongs to **OBJECT**.|
116| [UDMF_META_VCARD](#udmf_meta_vcard)   "general.vcard" | Generic electronic business card type.<br>This type belongs to **OBJECT**.|
117| [UDMF_META_NAVIGATION](#udmf_meta_navigation)   "general.navigation" | Generic navigation data type.<br>This type belongs to **OBJECT**.|
118| [UDMF_META_LOCATION](#udmf_meta_location)   "general.location" | Location data.<br>This type belongs to **NAVIGATION**.|
119| [UDMF_META_OPENHARMONY_FORM](#udmf_meta_openharmony_form)   "openharmony.form" | Widget defined for the system.<br>This type belongs to **OBJECT**.|
120| [UDMF_META_OPENHARMONY_APP_ITEM](#udmf_meta_openharmony_app_item)   "openharmony.app-item" | Home screen icon defined for the system.<br>This type belongs to **OBJECT**.|
121| [UDMF_META_OPENHARMONY_PIXEL_MAP](#udmf_meta_openharmony_pixel_map)   "openharmony.pixel-map" | Pixel map defined for the system.<br>This type belongs to **IMAGE**.|
122| [UDMF_META_OPENHARMONY_ATOMIC_SERVICE](#udmf_meta_openharmony_atomic_service)   "openharmony.atomic-service" | Atomic service type defined for the system.<br>This type belongs to **OBJECT**.|
123| [UDMF_META_OPENHARMONY_PACKAGE](#udmf_meta_openharmony_package)   "openharmony.package" | Package (compressed folder) defined for the system.<br>This type belongs to **DIRECTORY**.|
124| [UDMF_META_OPENHARMONY_HAP](#udmf_meta_openharmony_hap)   "openharmony.hap" | Ability package defined for the system.<br>This type belongs to **OPENHARMONY_PACKAGE**.|
125| [UDMF_META_SMIL](#udmf_meta_smil)   "com.real.smil" | Synchronized Multimedia Integration Language (SMIL).<br>This type belongs to **XML**.|
126| [UDMF_META_MARKDOWN](#udmf_meta_markdown)   "general.markdown" | Markdown.<br>This type belongs to **PLAIN_TEXT**.|
127| [UDMF_META_FAX](#udmf_meta_fax)   "general.fax" | Generic type of the fax.<br>This type belongs to **IMAGE**.|
128| [UDMF_META_JFX_FAX](#udmf_meta_jfx_fax)   "com.j2.jfx-fax" | J2 jConnect fax file format.<br>This type belongs to **FAX**.|
129| [UDMF_META_EFX_FAX](#udmf_meta_efx_fax)   "com.js.efx-fax" | EFX file format.<br>This type belongs to **FAX**.|
130| [UDMF_META_XBITMAP_IMAGE](#udmf_meta_xbitmap_image)   "general.xbitmap-image" | X BitMAP (XBM) used in the X Window system (X11).<br>This type belongs to **IMAGE**.|
131| [UDMF_META_TGA_IMAGE](#udmf_meta_tga_image)   "com.truevision.tga-image" | Tagged Graphics (TGA) format.<br>This type belongs to **IMAGE**.|
132| [UDMF_META_SGI_IMAGE](#udmf_meta_sgi_image)   "com.sgi.sgi-image" | Silicon Graphics image (SGI) format.<br>This type belongs to **IMAGE**.|
133| [UDMF_META_OPENEXR_IMAGE](#udmf_meta_openexr_image)   "com.ilm.openexr-image" | OpenXR image format.<br>This type belongs to **IMAGE**.|
134| [UDMF_META_FLASHPIX_IMAGE](#udmf_meta_flashpix_image)   "com.kodak.flashpix.image" | FlashPix image format.<br>This type belongs to **IMAGE**.|
135| [UDMF_META_REALMEDIA](#udmf_meta_realmedia)   "com.real.realmedia" | RealMedia format.<br>This type belongs to **VIDEO**.|
136| [UDMF_META_AU_AUDIO](#udmf_meta_au_audio)   "general.au-audio" | AU format.<br>This type belongs to **AUDIO**.|
137| [UDMF_META_AIFC_AUDIO](#udmf_meta_aifc_audio)   "general.aifc-audio" | AIFC.<br>This type belongs to **AUDIO**.|
138| [UDMF_META_SD2_AUDIO](#udmf_meta_sd2_audio)   "com.digidesign.sd2-audio" | Digidesign Sound Designer II (SDII).<br>This type belongs to **AUDIO**.|
139| [UDMF_META_REALAUDIO](#udmf_meta_realaudio)   "com.real.realaudio" | RealAudio.<br>This type belongs to **AUDIO**.|
140| [UDMF_META_OPENXML](#udmf_meta_openxml)   "org.openxmlformats.openxml" | OpenXML base type.<br>This type belongs to **ARCHIVE**.|
141| [UDMF_META_WORDPROCESSINGML_DOCUMENT](#udmf_meta_wordprocessingml_document)   "org.openxmlformats.wordprocessingml.document" | WordProcessingML format.<br>This type belongs to **OPENXML** and **COMPOSITE_OBJECT**.|
142| [UDMF_META_SPREADSHEETML_SHEET](#udmf_meta_spreadsheetml_sheet)   "org.openxmlformats.spreadsheetml.sheet" | SpreadsheetML format.<br>This type belongs to **OPENXML** and **COMPOSITE_OBJECT**.|
143| [UDMF_META_PRESENTATIONML_PRESENTATION](#udmf_meta_presentationml_presentation)   "org.openxmlformats.presentationml.presentation" | PresentationML format.<br>This type belongs to **OPENXML** and **COMPOSITE_OBJECT**.|
144| [UDMF_META_OPENDOCUMENT](#udmf_meta_opendocument)   "org.oasis.opendocument" | OpenDocument format for Office applications.<br>This type belongs to **ARCHIVE**.|
145| [UDMF_META_OPENDOCUMENT_TEXT](#udmf_meta_opendocument_text)   "org.oasis.opendocument.text" | OpenDocument format for word processing (text) documents.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.|
146| [UDMF_META_OPENDOCUMENT_SPREADSHEET](#udmf_meta_opendocument_spreadsheet)   "org.oasis.opendocument.spreadsheet" | OpenDocument format for spreadsheets.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.|
147| [UDMF_META_OPENDOCUMENT_PRESENTATION](#udmf_meta_opendocument_presentation)   "org.oasis.opendocument.presentation" | OpenDocument format for presentations.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.|
148| [UDMF_META_OPENDOCUMENT_GRAPHICS](#udmf_meta_opendocument_graphics)   "org.oasis.opendocument.graphics" | OpenDocument format for graphics.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.|
149| [UDMF_META_OPENDOCUMENT_FORMULA](#udmf_meta_opendocument_formula)   "org.oasis.opendocument.formula" | OpenDocument format for formula.<br>This type belongs to **OPENDOCUMENT**.|
150| [UDMF_META_STUFFIT_ARCHIVE](#udmf_meta_stuffit_archive)   "com.allume.stuffit-archive" | Stuffit compression format (stuffit archive).<br>This type belongs to **ARCHIVE**.|
151| [UDMF_META_VCS](#udmf_meta_vcs)   "general.vcs" | VCalendar (VCS) format.<br>This type belongs to **CALENDAR** and **TEXT**.|
152| [UDMF_META_ICS](#udmf_meta_ics)   "general.ics" | Internet Calendaring and Scheduling (ICS) format.<br>This type belongs to **CALENDAR** and **TEXT**.|
153| [UDMF_META_EXECUTABLE](#udmf_meta_executable)   "general.executable" | Generic type of all executable files.<br>This type belongs to **OBJECT**.|
154| [UDMF_META_PORTABLE_EXECUTABLE](#udmf_meta_portable_executable)   "com.microsoft.portable-executable" | Microsoft Windows portable executable format.<br>This type belongs to **EXECUTABLE**.|
155| [UDMF_META_SUN_JAVA_CLASS](#udmf_meta_sun_java_class)   "com.sun.java-class" | Java class file format.<br>This type belongs to **EXECUTABLE**.|
156| [UDMF_META_FONT](#udmf_meta_font)   "general.font" | Basic type of fonts.<br>This type belongs to **OBJECT**.|
157| [UDMF_META_TRUETYPE_FONT](#udmf_meta_truetype_font)   "general.truetype-font" | TrueType font format.<br>This type belongs to **FONT**.|
158| [UDMF_META_TRUETYPE_COLLECTION_FONT](#udmf_meta_truetype_collection_font)   "general.truetype-collection-font" | TrueType Collection font format.<br>This type belongs to **FONT**.|
159| [UDMF_META_OPENTYPE_FONT](#udmf_meta_opentype_font)   "general.opentype-font" | OpenType font format.<br>This type belongs to **FONT**.|
160| [UDMF_META_POSTSCRIPT_FONT](#udmf_meta_postscript_font)   "com.adobe.postscript-font" | PostScript font format.<br>This type belongs to **FONT**.|
161| [UDMF_META_POSTSCRIPT_PFB_FONT](#udmf_meta_postscript_pfb_font)   "com.adobe.postscript-pfb-font" | PostScript Font Binary font format.<br>This type belongs to **FONT**.|
162| [UDMF_META_POSTSCRIPT_PFA_FONT](#udmf_meta_postscript_pfa_font)   "com.adobe.postscript-pfa-font" | Adobe Type 1 font format.<br>This type belongs to **FONT**.|
163| [UDMF_META_OPENHARMONY_HDOC](#udmf_meta_openharmony_hdoc)   "openharmony.hdoc" | Memo format defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.|
164| [UDMF_META_OPENHARMONY_HINOTE](#udmf_meta_openharmony_hinote)   "openharmony.hinote" | Note format defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.|
165| [UDMF_META_OPENHARMONY_STYLED_STRING](#udmf_meta_openharmony_styled_string)   "openharmony.styled-string" | Style string type defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.|
166| [UDMF_META_OPENHARMONY_WANT](#udmf_meta_openharmony_want)   "openharmony.want" | Want defined for the system.<br>This type belongs to **OBJECT**.|
167| [UDMF_META_GENERAL_FILE_URI](#udmf_meta_general_file_uri)   "general.file-uri" | File address type.<br>This type belongs to **TEXT**.|
168| [UDMF_METE_GENERAL_CONTENT_FORM](#udmf_mete_general_content_form)   "general.content-form" | Content widget type.<br>This type belongs to **OBJECT**.|
169
170### Types
171
172| Name| Description|
173| -------- | -------- |
174| typedef enum [Udmf_Intention](#udmf_intention) [Udmf_Intention](#udmf_intention) | Defines an enum for UDMF data channels.|
175| typedef enum [Udmf_ShareOption](#udmf_shareoption) [Udmf_ShareOption](#udmf_shareoption) | Defines an enum for the scopes of the uniform data to be used on a device.|
176| typedef struct [OH_UdmfData](#oh_udmfdata) [OH_UdmfData](#oh_udmfdata) | Defines a struct for a uniform data object.|
177| typedef struct [OH_UdmfRecord](#oh_udmfrecord) [OH_UdmfRecord](#oh_udmfrecord) | Defines a struct for a data record in a uniform data object.|
178| typedef struct [OH_UdmfRecordProvider](#oh_udmfrecordprovider) [OH_UdmfRecordProvider](#oh_udmfrecordprovider) | Defines a struct for the data record provider in a uniform data object.|
179| typedef struct [OH_UdmfProperty](#oh_udmfproperty) [OH_UdmfProperty](#oh_udmfproperty) | Defines a struct for a data record property in a uniform data object.|
180| typedef void(\* [UdmfData_Finalize](#udmfdata_finalize)) (void \*context) | Defines a callback function used to release the context. This callback is invoked when the **OH_UdmfRecordProvider** instance is destroyed.|
181| typedef void \*(\* [OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata)) (void \*context, const char \*type) | Defines a callback function used to obtain data by type. This callback will be invoked to return the data obtained from **OH_UdmfRecord**.|
182| typedef enum [Udmf_ErrCode](#udmf_errcode) [Udmf_ErrCode](#udmf_errcode) | Defines an enum for error codes.|
183| typedef struct [OH_UdsPlainText](#oh_udsplaintext) [OH_UdsPlainText](#oh_udsplaintext) | Defines a struct for the uniform data of the plain text type.|
184| typedef struct [OH_UdsHyperlink](#oh_udshyperlink) [OH_UdsHyperlink](#oh_udshyperlink) | Defines a struct for the uniform data of the hyperlink type.|
185| typedef struct [OH_UdsHtml](#oh_udshtml) [OH_UdsHtml](#oh_udshtml) | Defines a struct for the uniform data of the Hypertext Markup Language (HTML) type.|
186| typedef struct [OH_UdsAppItem](#oh_udsappitem) [OH_UdsAppItem](#oh_udsappitem) | Defines a struct for the uniform data of the home screen icon type.|
187| typedef struct [OH_UdsFileUri](#oh_udsfileuri) [OH_UdsFileUri](#oh_udsfileuri) | Defines a struct for the file URI type.|
188| typedef struct [OH_UdsPixelMap](#oh_udspixelmap) [OH_UdsPixelMap](#oh_udspixelmap) | Defines a struct for the pixel map type.|
189| typedef struct [OH_UdsArrayBuffer](#oh_udsarraybuffer) [OH_UdsArrayBuffer](#oh_udsarraybuffer) | Defines a struct for the ArrayBuffer type.|
190| typedef struct [OH_Utd](#oh_utd) [OH_Utd](#oh_utd) | Defines a struct for a Uniform Type Descriptor (UTD).|
191| typedef struct [OH_UdsContentForm](#oh_udscontentform) [OH_UdsContentForm](#oh_udscontentform) | Defines a struct for the uniform data of the content widget type.|
192| typedef enum [Udmf_ListenerStatus](#udmf_listenerstatus) [Udmf_ListenerStatus](#udmf_listenerstatus) | Defines an enum for the status codes returned when data is obtained asynchronously.|
193| typedef enum [Udmf_FileConflictOptions](#udmf_fileconflictoptions) [Udmf_FileConflictOptions](#udmf_fileconflictoptions) | Defines an enum for the options used to resolve file copy conflicts.|
194| typedef enum [Udmf_ProgressIndicator](#udmf_progressindicator) [Udmf_ProgressIndicator](#udmf_progressindicator) | Defines an enum for the progress indicator options.|
195| typedef struct [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo) [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo) | Defines a struct for progress information.|
196| typedef struct [OH_UdmfGetDataParams](#oh_udmfgetdataparams) [OH_UdmfGetDataParams](#oh_udmfgetdataparams) | Defines a struct for parameters used to obtain UDMF data asynchronously.|
197| typedef void(\* [OH_Udmf_DataProgressListener](#oh_udmf_dataprogresslistener)) ([OH_Udmf_ProgressInfo](#oh_udmf_progressinfo) \*progressInfo, [OH_UdmfData](#oh_udmfdata) \*data) | Defines the callback used to return the data retrieval progress information and data obtained.<br>A null pointer is returned if the progress is not 100. The data obtained is returned only when the progress reaches 100.|
198
199### Enums
200
201| Name| Description|
202| -------- | -------- |
203| [Udmf_Intention](#udmf_intention) { UDMF_INTENTION_DRAG, UDMF_INTENTION_PASTEBOARD } | Enumerates the UDMF data channel types. |
204| [Udmf_ShareOption](#udmf_shareoption-1) { SHARE_OPTIONS_INVALID, SHARE_OPTIONS_IN_APP, SHARE_OPTIONS_CROSS_APP } | Enumerates the scopes of the uniform data to be used on a device. |
205| [Udmf_ErrCode](#udmf_errcode-1) { UDMF_E_OK = 0, UDMF_ERR = 20400000, UDMF_E_INVALID_PARAM = (UDMF_ERR + 1) } | Enumerates the error codes.|
206| [Udmf_ListenerStatus](#udmf_listenerstatus-1) {<br>UDMF_FINISHED = 0, UDMF_PROCESSING, UDMF_CANCELED, UDMF_INNER_ERROR = 200,<br>UDMF_INVALID_PARAMETERS, UDMF_DATA_NOT_FOUND, UDMF_SYNC_FAILED, UDMF_COPY_FILE_FAILED<br>} | Enumerates the status codes returned when data is obtained asynchronously.|
207| [Udmf_FileConflictOptions](#udmf_fileconflictoptions-1) { UDMF_OVERWRITE = 0, UDMF_SKIP = 1 } | Enumerates the options used to resolve file copy conflicts.|
208| [Udmf_ProgressIndicator](#udmf_progressindicator-1) { UDMF_NONE = 0, UDMF_DEFAULT = 1 } | Enumerates the progress indicator options.|
209
210
211### Functions
212
213| Name| Description|
214| -------- | -------- |
215| int [OH_UdmfProgressInfo_GetProgress](#oh_udmfprogressinfo_getprogress) ([OH_Udmf_ProgressInfo](#oh_udmf_progressinfo) \*progressInfo) | Obtains the progress information from [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).|
216| int [OH_UdmfProgressInfo_GetStatus](#oh_udmfprogressinfo_getstatus) ([OH_Udmf_ProgressInfo](#oh_udmf_progressinfo) \*progressInfo) | Obtains the status information from [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).|
217| [OH_UdmfGetDataParams](#oh_udmfgetdataparams) \* [OH_UdmfGetDataParams_Create](#oh_udmfgetdataparams_create) () | Creates an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance for asynchronously obtaining UDMF data.<br>If this pointer is no longer required, use [OH_UdmfGetDataParams_Destroy](#oh_udmfgetdataparams_destroy) to destroy it. Otherwise, memory leaks may occur.|
218| void [OH_UdmfGetDataParams_Destroy](#oh_udmfgetdataparams_destroy) ([OH_UdmfGetDataParams](#oh_udmfgetdataparams) \*pThis) | Destroys an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
219| void [OH_UdmfGetDataParams_SetDestUri](#oh_udmfgetdataparams_setdesturi) ([OH_UdmfGetDataParams](#oh_udmfgetdataparams) \*params, const char \*destUri) | Sets the destination directory in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.<br>If the destination directory is set, data of the file type will be copied to the specified directory. The file type data obtained in the callback will be replaced with the URI of the destination directory.<br>If the destination directory is not specified, the file will not be copied. The file type data obtained in the callback is the URI of the source directory.<br>If the application involves complex file processing or files need to be copied to multiple directories, you are advised to leave this parameter unspecified and let the application to handle the file copy.|
220| void [OH_UdmfGetDataParams_SetFileConflictOptions](#oh_udmfgetdataparams_setfileconflictoptions) ([OH_UdmfGetDataParams](#oh_udmfgetdataparams) \*params, const [Udmf_FileConflictOptions](#udmf_fileconflictoptions) options) | Sets the policy for resolving file conflicts in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
221| void [OH_UdmfGetDataParams_SetProgressIndicator](#oh_udmfgetdataparams_setprogressindicator) ([OH_UdmfGetDataParams](#oh_udmfgetdataparams) \*params, const [Udmf_ProgressIndicator](#udmf_progressindicator) progressIndicator) | Sets the progress indicator in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
222| void [OH_UdmfGetDataParams_SetDataProgressListener](#oh_udmfgetdataparams_setdataprogresslistener) ([OH_UdmfGetDataParams](#oh_udmfgetdataparams) \*params, const [OH_Udmf_DataProgressListener](#oh_udmf_dataprogresslistener) dataProgressListener) | Sets the callback used to return the data obtained in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
223| int [OH_UdmfRecord_AddContentForm](#oh_udmfrecord_addcontentform) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsContentForm](#oh_udscontentform) \*contentForm) | Adds data of the [OH_UdsContentForm](#oh_udscontentform) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
224| int [OH_UdmfRecord_GetContentForm](#oh_udmfrecord_getcontentform) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsContentForm](#oh_udscontentform) \*contentForm) | Obtains data of the [OH_UdsContentForm](#oh_udscontentform) type from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
225| [OH_UdsContentForm](#oh_udscontentform) \* [OH_UdsContentForm_Create](#oh_udscontentform_create) () | Creates an [OH_UdsContentForm](#oh_udscontentform) instance and a pointer to it.|
226| void [OH_UdsContentForm_Destroy](#oh_udscontentform_destroy) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Destroys an [OH_UdsContentForm](#oh_udscontentform) instance.|
227| const char \* [OH_UdsContentForm_GetType](#oh_udscontentform_gettype) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Obtains the type ID from an [OH_UdsContentForm](#oh_udscontentform) instance.|
228| int [OH_UdsContentForm_GetThumbData](#oh_udscontentform_getthumbdata) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, unsigned char \*\*thumbData, unsigned int \*len) | Obtains image data from an [OH_UdsContentForm](#oh_udscontentform) instance.|
229| const char \* [OH_UdsContentForm_GetDescription](#oh_udscontentform_getdescription) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Obtains the description from an [OH_UdsContentForm](#oh_udscontentform) instance.|
230| const char \* [OH_UdsContentForm_GetTitle](#oh_udscontentform_gettitle) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Obtains the title from an [OH_UdsContentForm](#oh_udscontentform) instance.|
231| int [OH_UdsContentForm_GetAppIcon](#oh_udscontentform_getappicon) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, unsigned char \*\*appIcon, unsigned int \*len) | Obtains the application icon data from an [OH_UdsContentForm](#oh_udscontentform) instance.|
232| const char \* [OH_UdsContentForm_GetAppName](#oh_udscontentform_getappname) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Obtains the application name from an [OH_UdsContentForm](#oh_udscontentform) instance.|
233| const char \* [OH_UdsContentForm_GetLinkUri](#oh_udscontentform_getlinkuri) ([OH_UdsContentForm](#oh_udscontentform) \*pThis) | Obtains the hyperlink information from an [OH_UdsContentForm](#oh_udscontentform) instance.|
234| int [OH_UdsContentForm_SetThumbData](#oh_udscontentform_setthumbdata) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const unsigned char \*thumbData, unsigned int len) | Sets the image data for an [OH_UdsContentForm](#oh_udscontentform) instance.|
235| int [OH_UdsContentForm_SetDescription](#oh_udscontentform_setdescription) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const char \*description) | Sets the description for an [OH_UdsContentForm](#oh_udscontentform) instance.|
236| int [OH_UdsContentForm_SetTitle](#oh_udscontentform_settitle) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const char \*title) | Sets the title for an [OH_UdsContentForm](#oh_udscontentform) instance.|
237| int [OH_UdsContentForm_SetAppIcon](#oh_udscontentform_setappicon) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const unsigned char \*appIcon, unsigned int len) | Sets the application icon data for an [OH_UdsContentForm](#oh_udscontentform) instance.|
238| int [OH_UdsContentForm_SetAppName](#oh_udscontentform_setappname) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const char \*appName) | Sets the application name for an [OH_UdsContentForm](#oh_udscontentform) instance.|
239| int [OH_UdsContentForm_SetLinkUri](#oh_udscontentform_setlinkuri) ([OH_UdsContentForm](#oh_udscontentform) \*pThis, const char \*linkUri) | Sets the hyperlink data for an [OH_UdsContentForm](#oh_udscontentform) instance.|
240| [OH_UdmfData](#oh_udmfdata) \* [OH_UdmfData_Create](#oh_udmfdata_create) () | Creates an [OH_UdmfData](#oh_udmfdata) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfData_Destroy](#oh_udmfdata_destroy) to destroy it. Otherwise, memory leaks may occur.|
241| void [OH_UdmfData_Destroy](#oh_udmfdata_destroy) ([OH_UdmfData](#oh_udmfdata) \*pThis) | Destroys an [OH_UdmfData](#oh_udmfdata) instance.|
242| int [OH_UdmfData_AddRecord](#oh_udmfdata_addrecord) ([OH_UdmfData](#oh_udmfdata) \*pThis, [OH_UdmfRecord](#oh_udmfrecord) \*record) | Adds an [OH_UdmfRecord](#oh_udmfrecord) to an [OH_UdmfData](#oh_udmfdata) instance.|
243| bool [OH_UdmfData_HasType](#oh_udmfdata_hastype) ([OH_UdmfData](#oh_udmfdata) \*pThis, const char \*type) | Checks whether the specified type exists in an [OH_UdmfData](#oh_udmfdata) instance.|
244| char \*\* [OH_UdmfData_GetTypes](#oh_udmfdata_gettypes) ([OH_UdmfData](#oh_udmfdata) \*pThis, unsigned int \*count) | Obtains all data types in an [OH_UdmfData](#oh_udmfdata) instance.|
245| [OH_UdmfRecord](#oh_udmfrecord) \*\* [OH_UdmfData_GetRecords](#oh_udmfdata_getrecords) ([OH_UdmfData](#oh_udmfdata) \*pThis, unsigned int \*count) | Obtains all records contained in an [OH_UdmfData](#oh_udmfdata) instance.|
246| [OH_UdmfRecordProvider](#oh_udmfrecordprovider) \* [OH_UdmfRecordProvider_Create](#oh_udmfrecordprovider_create) () | Creates an [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfRecordProvider_Destroy](#oh_udmfrecordprovider_destroy) to destroy it. Otherwise, memory leaks may occur.|
247| int [OH_UdmfRecordProvider_Destroy](#oh_udmfrecordprovider_destroy) ([OH_UdmfRecordProvider](#oh_udmfrecordprovider) \*provider) | Destroys an [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance.|
248| int [OH_UdmfRecordProvider_SetData](#oh_udmfrecordprovider_setdata) ([OH_UdmfRecordProvider](#oh_udmfrecordprovider) \*provider, void \*context, const [OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata) callback, const [UdmfData_Finalize](#udmfdata_finalize) finalize) | Sets a callback for an **OH_UdmfRecordProvider** instance to provide data.|
249| [OH_UdmfRecord](#oh_udmfrecord) \* [OH_UdmfRecord_Create](#oh_udmfrecord_create) () | Creates an [OH_UdmfRecord](#oh_udmfrecord) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfRecord_Destroy](#oh_udmfrecord_destroy) to destroy it. Otherwise, memory leaks may occur.|
250| void [OH_UdmfRecord_Destroy](#oh_udmfrecord_destroy) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis) | Destroys an [OH_UdmfRecord](#oh_udmfrecord) instance.|
251| int [OH_UdmfRecord_AddGeneralEntry](#oh_udmfrecord_addgeneralentry) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, const char \*typeId, unsigned char \*entry, unsigned int count) | Adds customized uniform data to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
252| int [OH_UdmfRecord_AddPlainText](#oh_udmfrecord_addplaintext) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsPlainText](#oh_udsplaintext) \*plainText) | Adds data of the [OH_UdsPlainText](#oh_udsplaintext) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
253| int [OH_UdmfRecord_AddHyperlink](#oh_udmfrecord_addhyperlink) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsHyperlink](#oh_udshyperlink) \*hyperlink) | Adds data of the hyperlink type [OH_UdsHyperlink](#oh_udshyperlink) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
254| int [OH_UdmfRecord_AddHtml](#oh_udmfrecord_addhtml) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsHtml](#oh_udshtml) \*html) | Adds data of the [OH_UdsHtml](#oh_udshtml) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
255| int [OH_UdmfRecord_AddAppItem](#oh_udmfrecord_addappitem) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsAppItem](#oh_udsappitem) \*appItem) | Adds data of the [OH_UdsAppItem](#oh_udsappitem) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
256| int [OH_UdmfRecord_AddFileUri](#oh_udmfrecord_addfileuri) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsFileUri](#oh_udsfileuri) \*fileUri) | Adds a data record of the [OH_UdsFileUri](#oh_udsfileuri) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
257| int [OH_UdmfRecord_AddPixelMap](#oh_udmfrecord_addpixelmap) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsPixelMap](#oh_udspixelmap) \*pixelMap) | Adds a data record of the [OH_UdsPixelMap](#oh_udspixelmap) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
258| int [OH_UdmfRecord_AddArrayBuffer](#oh_udmfrecord_addarraybuffer) ([OH_UdmfRecord](#oh_udmfrecord) \*record, const char \*type, [OH_UdsArrayBuffer](#oh_udsarraybuffer) \*buffer) | Adds a data record of the [OH_UdsArrayBuffer](#oh_udsarraybuffer) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.|
259| char \*\* [OH_UdmfRecord_GetTypes](#oh_udmfrecord_gettypes) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, unsigned int \*count) | Obtains all data types in an [OH_UdmfRecord](#oh_udmfrecord) instance.|
260| int [OH_UdmfRecord_GetGeneralEntry](#oh_udmfrecord_getgeneralentry) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, const char \*typeId, unsigned char \*\*entry, unsigned int \*count) | Obtains the data of the specified type in an [OH_UdmfRecord](#oh_udmfrecord) instance.|
261| int [OH_UdmfRecord_GetPlainText](#oh_udmfrecord_getplaintext) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsPlainText](#oh_udsplaintext) \*plainText) | Obtains [OH_UdsPlainText](#oh_udsplaintext) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
262| int [OH_UdmfRecord_GetHyperlink](#oh_udmfrecord_gethyperlink) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsHyperlink](#oh_udshyperlink) \*hyperlink) | Obtains [OH_UdsHyperlink](#oh_udshyperlink) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
263| int [OH_UdmfRecord_GetHtml](#oh_udmfrecord_gethtml) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsHtml](#oh_udshtml) \*html) | Obtains [OH_UdsHtml](#oh_udshtml) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
264| int [OH_UdmfRecord_GetAppItem](#oh_udmfrecord_getappitem) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsAppItem](#oh_udsappitem) \*appItem) | Obtains [OH_UdsAppItem](#oh_udsappitem) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
265| int [OH_UdmfRecord_SetProvider](#oh_udmfrecord_setprovider) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, const char \*const \*types, unsigned int count, [OH_UdmfRecordProvider](#oh_udmfrecordprovider) \*provider) | Sets the [OH_UdmfRecordProvider](#oh_udmfrecordprovider) in an [OH_UdmfRecord](#oh_udmfrecord) instance.|
266| int [OH_UdmfRecord_GetFileUri](#oh_udmfrecord_getfileuri) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsFileUri](#oh_udsfileuri) \*fileUri) | Obtains the [OH_UdsFileUri](#oh_udsfileuri) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
267| int [OH_UdmfRecord_GetPixelMap](#oh_udmfrecord_getpixelmap) ([OH_UdmfRecord](#oh_udmfrecord) \*pThis, [OH_UdsPixelMap](#oh_udspixelmap) \*pixelMap) | Obtains the [OH_UdsPixelMap](#oh_udspixelmap) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
268| int [OH_UdmfRecord_GetArrayBuffer](#oh_udmfrecord_getarraybuffer) ([OH_UdmfRecord](#oh_udmfrecord) \*record, const char \*type, [OH_UdsArrayBuffer](#oh_udsarraybuffer) \*buffer) | Obtains the [OH_UdsArrayBuffer](#oh_udsarraybuffer) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.|
269| int [OH_UdmfData_GetPrimaryPlainText](#oh_udmfdata_getprimaryplaintext) ([OH_UdmfData](#oh_udmfdata) \*data, [OH_UdsPlainText](#oh_udsplaintext) \*plainText) | Obtains the first [OH_UdsPlainText](#oh_udsplaintext) data from an [OH_UdmfData](#oh_udmfdata) instance.|
270| int [OH_UdmfData_GetPrimaryHtml](#oh_udmfdata_getprimaryhtml) ([OH_UdmfData](#oh_udmfdata) \*data, [OH_UdsHtml](#oh_udshtml) \*html) | Obtains the first [OH_UdsHtml](#oh_udshtml) data from an [OH_UdmfData](#oh_udmfdata) instance.|
271| int [OH_UdmfData_GetRecordCount](#oh_udmfdata_getrecordcount) ([OH_UdmfData](#oh_udmfdata) \*data) | Obtains the number of data records contained in an [OH_UdmfData](#oh_udmfdata) instance.|
272| [OH_UdmfRecord](#oh_udmfrecord) \* [OH_UdmfData_GetRecord](#oh_udmfdata_getrecord) ([OH_UdmfData](#oh_udmfdata) \*data, unsigned int index) | Obtains the specified data record from an [OH_UdmfData](#oh_udmfdata) instance.|
273| bool [OH_UdmfData_IsLocal](#oh_udmfdata_islocal) ([OH_UdmfData](#oh_udmfdata) \*data) | Checks whether an [OH_UdmfData](#oh_udmfdata) instance is from the local device.|
274| [OH_UdmfProperty](#oh_udmfproperty) \* [OH_UdmfProperty_Create](#oh_udmfproperty_create) ([OH_UdmfData](#oh_udmfdata) \*unifiedData) | Creates an [OH_UdmfProperty](#oh_udmfproperty) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfProperty_Destroy](#oh_udmfproperty_destroy) to destroy it. Otherwise, memory leaks may occur.|
275| void [OH_UdmfProperty_Destroy](#oh_udmfproperty_destroy) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis) | Destroys an [OH_UdmfProperty](#oh_udmfproperty) instance.|
276| const char \* [OH_UdmfProperty_GetTag](#oh_udmfproperty_gettag) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis) | Obtains the custom tag value from an [OH_UdmfProperty](#oh_udmfproperty) instance.|
277| int64_t [OH_UdmfProperty_GetTimestamp](#oh_udmfproperty_gettimestamp) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis) | Obtains the timestamp from an [OH_UdmfProperty](#oh_udmfproperty) instance.|
278| [Udmf_ShareOption](#udmf_shareoption) [OH_UdmfProperty_GetShareOption](#oh_udmfproperty_getshareoption) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis) | Obtains the share option from an [OH_UdmfProperty](#oh_udmfproperty) instance.|
279| int [OH_UdmfProperty_GetExtrasIntParam](#oh_udmfproperty_getextrasintparam) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, const char \*key, int defaultValue) | Obtains the customized extra integer parameter from an [OH_UdmfProperty](#oh_udmfproperty) instance.|
280| const char \* [OH_UdmfProperty_GetExtrasStringParam](#oh_udmfproperty_getextrasstringparam) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, const char \*key) | Obtains the customized extra string parameter from an [OH_UdmfProperty](#oh_udmfproperty) instance.|
281| int [OH_UdmfProperty_SetTag](#oh_udmfproperty_settag) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, const char \*tag) | Sets the tag value for an [OH_UdmfProperty](#oh_udmfproperty) instance.|
282| int [OH_UdmfProperty_SetShareOption](#oh_udmfproperty_setshareoption) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, [Udmf_ShareOption](#udmf_shareoption) option) | Sets the share option for an [OH_UdmfProperty](#oh_udmfproperty) instance.|
283| int [OH_UdmfProperty_SetExtrasIntParam](#oh_udmfproperty_setextrasintparam) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, const char \*key, int param) | Sets the extra integer parameter for an [OH_UdmfProperty](#oh_udmfproperty) instance.|
284| int [OH_UdmfProperty_SetExtrasStringParam](#oh_udmfproperty_setextrasstringparam) ([OH_UdmfProperty](#oh_udmfproperty) \*pThis, const char \*key, const char \*param) | Sets the extra string parameter for an [OH_UdmfProperty](#oh_udmfproperty) instance.|
285| int [OH_Udmf_GetUnifiedData](#oh_udmf_getunifieddata) (const char \*key, [Udmf_Intention](#udmf_intention) intention, [OH_UdmfData](#oh_udmfdata) \*unifiedData) | Obtains an [OH_UdmfData](#oh_udmfdata) instance from the UDMF database.|
286| int [OH_Udmf_SetUnifiedData](#oh_udmf_setunifieddata) ([Udmf_Intention](#udmf_intention) intention, [OH_UdmfData](#oh_udmfdata) \*unifiedData, char \*key, unsigned int keyLen) | Sets an [OH_UdmfData](#oh_udmfdata) instance in the UDMF database.|
287| [OH_UdsPlainText](#oh_udsplaintext) \* [OH_UdsPlainText_Create](#oh_udsplaintext_create) () | Creates an [OH_UdsPlainText](#oh_udsplaintext) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPlainText_Destroy](#oh_udsplaintext_destroy) to destroy it. Otherwise, memory leaks may occur.|
288| void [OH_UdsPlainText_Destroy](#oh_udsplaintext_destroy) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis) | Destroys an [OH_UdsPlainText](#oh_udsplaintext) instance.|
289| const char \* [OH_UdsPlainText_GetType](#oh_udsplaintext_gettype) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis) | Obtains the type ID from an [OH_UdsPlainText](#oh_udsplaintext) instance.|
290| const char \* [OH_UdsPlainText_GetContent](#oh_udsplaintext_getcontent) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis) | Obtains the plaintext from an [OH_UdsPlainText](#oh_udsplaintext) instance.|
291| const char \* [OH_UdsPlainText_GetAbstract](#oh_udsplaintext_getabstract) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis) | Obtains the abstract from an [OH_UdsPlainText](#oh_udsplaintext) instance.|
292| int [OH_UdsPlainText_SetContent](#oh_udsplaintext_setcontent) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis, const char \*content) | Sets the plaintext for an [OH_UdsPlainText](#oh_udsplaintext) instance.|
293| int [OH_UdsPlainText_SetAbstract](#oh_udsplaintext_setabstract) ([OH_UdsPlainText](#oh_udsplaintext) \*pThis, const char \*abstract) | Sets the abstract for an [OH_UdsPlainText](#oh_udsplaintext) instance.|
294| [OH_UdsHyperlink](#oh_udshyperlink) \* [OH_UdsHyperlink_Create](#oh_udshyperlink_create) () | Creates an [OH_UdsHyperlink](#oh_udshyperlink) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHyperlink_Destroy](#oh_udshyperlink_destroy) to destroy it. Otherwise, memory leaks may occur.|
295| void [OH_UdsHyperlink_Destroy](#oh_udshyperlink_destroy) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis) | Destroys an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
296| const char \* [OH_UdsHyperlink_GetType](#oh_udshyperlink_gettype) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis) | Obtains the type ID from an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
297| const char \* [OH_UdsHyperlink_GetUrl](#oh_udshyperlink_geturl) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis) | Obtains the URL from an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
298| const char \* [OH_UdsHyperlink_GetDescription](#oh_udshyperlink_getdescription) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis) | Obtains the description from an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
299| int [OH_UdsHyperlink_SetUrl](#oh_udshyperlink_seturl) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis, const char \*url) | Sets the URL for an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
300| int [OH_UdsHyperlink_SetDescription](#oh_udshyperlink_setdescription) ([OH_UdsHyperlink](#oh_udshyperlink) \*pThis, const char \*description) | Sets the description for an [OH_UdsHyperlink](#oh_udshyperlink) instance.|
301| [OH_UdsHtml](#oh_udshtml) \* [OH_UdsHtml_Create](#oh_udshtml_create) () | Creates an [OH_UdsHtml](#oh_udshtml) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHtml_Destroy](#oh_udshtml_destroy) to destroy it. Otherwise, memory leaks may occur.|
302| void [OH_UdsHtml_Destroy](#oh_udshtml_destroy) ([OH_UdsHtml](#oh_udshtml) \*pThis) | Destroys an [OH_UdsHtml](#oh_udshtml) instance.|
303| const char \* [OH_UdsHtml_GetType](#oh_udshtml_gettype) ([OH_UdsHtml](#oh_udshtml) \*pThis) | Obtains the type ID from an [OH_UdsHtml](#oh_udshtml) instance.|
304| const char \* [OH_UdsHtml_GetContent](#oh_udshtml_getcontent) ([OH_UdsHtml](#oh_udshtml) \*pThis) | Obtains the HTML content from an [OH_UdsHtml](#oh_udshtml) instance.|
305| const char \* [OH_UdsHtml_GetPlainContent](#oh_udshtml_getplaincontent) ([OH_UdsHtml](#oh_udshtml) \*pThis) | Obtains the plaintext from an [OH_UdsHtml](#oh_udshtml) instance.|
306| int [OH_UdsHtml_SetContent](#oh_udshtml_setcontent) ([OH_UdsHtml](#oh_udshtml) \*pThis, const char \*content) | Sets the HTML content for an [OH_UdsHtml](#oh_udshtml) instance.|
307| int [OH_UdsHtml_SetPlainContent](#oh_udshtml_setplaincontent) ([OH_UdsHtml](#oh_udshtml) \*pThis, const char \*plainContent) | Sets the plaintext for an [OH_UdsHtml](#oh_udshtml) instance.|
308| [OH_UdsAppItem](#oh_udsappitem) \* [OH_UdsAppItem_Create](#oh_udsappitem_create) () | Creates an [OH_UdsAppItem](#oh_udsappitem) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsAppItem_Destroy](#oh_udsappitem_destroy) to destroy it. Otherwise, memory leaks may occur.|
309| void [OH_UdsAppItem_Destroy](#oh_udsappitem_destroy) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Destroys an [OH_UdsAppItem](#oh_udsappitem) instance.|
310| const char \* [OH_UdsAppItem_GetType](#oh_udsappitem_gettype) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the type ID from an [OH_UdsAppItem](#oh_udsappitem) instance.|
311| const char \* [OH_UdsAppItem_GetId](#oh_udsappitem_getid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the application ID from an [OH_UdsAppItem](#oh_udsappitem) instance.|
312| const char \* [OH_UdsAppItem_GetName](#oh_udsappitem_getname) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the application name from an [OH_UdsAppItem](#oh_udsappitem) instance.|
313| const char \* [OH_UdsAppItem_GetIconId](#oh_udsappitem_geticonid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the application icon ID from an [OH_UdsAppItem](#oh_udsappitem) instance.|
314| const char \* [OH_UdsAppItem_GetLabelId](#oh_udsappitem_getlabelid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the application label ID from an [OH_UdsAppItem](#oh_udsappitem) instance.|
315| const char \* [OH_UdsAppItem_GetBundleName](#oh_udsappitem_getbundlename) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the bundle name from an [OH_UdsAppItem](#oh_udsappitem) instance.|
316| const char \* [OH_UdsAppItem_GetAbilityName](#oh_udsappitem_getabilityname) ([OH_UdsAppItem](#oh_udsappitem) \*pThis) | Obtains the ability name from an [OH_UdsAppItem](#oh_udsappitem) instance.|
317| int [OH_UdsAppItem_SetId](#oh_udsappitem_setid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*appId) | Sets the application ID for an [OH_UdsAppItem](#oh_udsappitem) instance.|
318| int [OH_UdsAppItem_SetName](#oh_udsappitem_setname) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*appName) | Sets the application name for an [OH_UdsAppItem](#oh_udsappitem) instance.|
319| int [OH_UdsAppItem_SetIconId](#oh_udsappitem_seticonid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*appIconId) | Sets the application icon ID for an [OH_UdsAppItem](#oh_udsappitem) instance.|
320| int [OH_UdsAppItem_SetLabelId](#oh_udsappitem_setlabelid) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*appLabelId) | Sets the application label ID for an [OH_UdsAppItem](#oh_udsappitem) instance.|
321| int [OH_UdsAppItem_SetBundleName](#oh_udsappitem_setbundlename) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*bundleName) | Sets the bundle name for an [OH_UdsAppItem](#oh_udsappitem) instance.|
322| int [OH_UdsAppItem_SetAbilityName](#oh_udsappitem_setabilityname) ([OH_UdsAppItem](#oh_udsappitem) \*pThis, const char \*abilityName) | Sets the ability name for an [OH_UdsAppItem](#oh_udsappitem) instance.|
323| [OH_UdsFileUri](#oh_udsfileuri) \* [OH_UdsFileUri_Create](#oh_udsfileuri_create) () | Creates an [OH_UdsFileUri](#oh_udsfileuri) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsFileUri_Destroy](#oh_udsfileuri_destroy) to destroy it. Otherwise, memory leaks may occur.|
324| void [OH_UdsFileUri_Destroy](#oh_udsfileuri_destroy) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis) | Destroys an [OH_UdsFileUri](#oh_udsfileuri) instance.|
325| const char \* [OH_UdsFileUri_GetType](#oh_udsfileuri_gettype) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis) | Obtains the type ID from an [OH_UdsFileUri](#oh_udsfileuri) instance.|
326| const char \* [OH_UdsFileUri_GetFileUri](#oh_udsfileuri_getfileuri) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis) | Obtains the file URI from an [OH_UdsFileUri](#oh_udsfileuri) instance.|
327| const char \* [OH_UdsFileUri_GetFileType](#oh_udsfileuri_getfiletype) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis) | Obtains the file type from an [OH_UdsFileUri](#oh_udsfileuri) instance.|
328| int [OH_UdsFileUri_SetFileUri](#oh_udsfileuri_setfileuri) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis, const char \*fileUri) | Sets the URI information for an [OH_UdsFileUri](#oh_udsfileuri) instance.|
329| int [OH_UdsFileUri_SetFileType](#oh_udsfileuri_setfiletype) ([OH_UdsFileUri](#oh_udsfileuri) \*pThis, const char \*fileType) | Sets the file type for an [OH_UdsFileUri](#oh_udsfileuri) instance.|
330| [OH_UdsPixelMap](#oh_udspixelmap) \* [OH_UdsPixelMap_Create](#oh_udspixelmap_create) () | Creates an [OH_UdsPixelMap](#oh_udspixelmap) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPixelMap_Destroy](#oh_udspixelmap_destroy) to destroy it. Otherwise, memory leaks may occur.|
331| void [OH_UdsPixelMap_Destroy](#oh_udspixelmap_destroy) ([OH_UdsPixelMap](#oh_udspixelmap) \*pThis) | Destroys an [OH_UdsPixelMap](#oh_udspixelmap) instance.|
332| const char \* [OH_UdsPixelMap_GetType](#oh_udspixelmap_gettype) ([OH_UdsPixelMap](#oh_udspixelmap) \*pThis) | Obtains the type ID from an [OH_UdsPixelMap](#oh_udspixelmap) instance.|
333| void [OH_UdsPixelMap_GetPixelMap](#oh_udspixelmap_getpixelmap) ([OH_UdsPixelMap](#oh_udspixelmap) \*pThis, OH_PixelmapNative \*pixelmapNative) | Obtains the pointer to the **OH_PixelmapNative** instance from an [OH_UdsPixelMap](#oh_udspixelmap) instance.|
334| int [OH_UdsPixelMap_SetPixelMap](#oh_udspixelmap_setpixelmap) ([OH_UdsPixelMap](#oh_udspixelmap) \*pThis, OH_PixelmapNative \*pixelmapNative) | Sets the pixel map content for an [OH_UdsPixelMap](#oh_udspixelmap) instance.|
335| [OH_UdsArrayBuffer](#oh_udsarraybuffer) \* [OH_UdsArrayBuffer_Create](#oh_udsarraybuffer_create) () | Creates an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsArrayBuffer_Destroy](#oh_udsarraybuffer_destroy) to destroy it. Otherwise, memory leaks may occur.|
336| int [OH_UdsArrayBuffer_Destroy](#oh_udsarraybuffer_destroy) ([OH_UdsArrayBuffer](#oh_udsarraybuffer) \*buffer) | Destroys an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.|
337| int [OH_UdsArrayBuffer_SetData](#oh_udsarraybuffer_setdata) ([OH_UdsArrayBuffer](#oh_udsarraybuffer) \*buffer, unsigned char \*data, unsigned int len) | Sets an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.|
338| int [OH_UdsArrayBuffer_GetData](#oh_udsarraybuffer_getdata) ([OH_UdsArrayBuffer](#oh_udsarraybuffer) \*buffer, unsigned char \*\*data, unsigned int \*len) | Obtains the custom ArrayBuffer data from an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.|
339| [OH_Utd](#oh_utd) \* [OH_Utd_Create](#oh_utd_create) (const char \*typeId) | Creates an [OH_Utd](#oh_utd) instance and a pointer to it.|
340| void [OH_Utd_Destroy](#oh_utd_destroy) ([OH_Utd](#oh_utd) \*pThis) | Destroys an [OH_Utd](#oh_utd) instance.|
341| const char \* [OH_Utd_GetTypeId](#oh_utd_gettypeid) ([OH_Utd](#oh_utd) \*pThis) | Obtains the type ID from an [OH_Utd](#oh_utd) instance.|
342| const char \* [OH_Utd_GetDescription](#oh_utd_getdescription) ([OH_Utd](#oh_utd) \*pThis) | Obtains the description from an [OH_Utd](#oh_utd) instance.|
343| const char \* [OH_Utd_GetReferenceUrl](#oh_utd_getreferenceurl) ([OH_Utd](#oh_utd) \*pThis) | Obtains the URL from an [OH_Utd](#oh_utd) instance.|
344| const char \* [OH_Utd_GetIconFile](#oh_utd_geticonfile) ([OH_Utd](#oh_utd) \*pThis) | Obtains the path of the default icon file from an [OH_Utd](#oh_utd) instance.|
345| const char \*\* [OH_Utd_GetBelongingToTypes](#oh_utd_getbelongingtotypes) ([OH_Utd](#oh_utd) \*pThis, unsigned int \*count) | Obtains the relationships between the data in an [OH_Utd](#oh_utd) instance.|
346| const char \*\* [OH_Utd_GetFilenameExtensions](#oh_utd_getfilenameextensions) ([OH_Utd](#oh_utd) \*pThis, unsigned int \*count) | Obtains the file name extensions associated with an [OH_Utd](#oh_utd) instance.|
347| const char \*\* [OH_Utd_GetMimeTypes](#oh_utd_getmimetypes) ([OH_Utd](#oh_utd) \*pThis, unsigned int \*count) | Obtains the MIME types associated with an [OH_Utd](#oh_utd) instance.|
348| const char \*\* [OH_Utd_GetTypesByFilenameExtension](#oh_utd_gettypesbyfilenameextension) (const char \*extension, unsigned int \*count) | Obtains the uniform data types based on the file name extensions.|
349| const char \*\* [OH_Utd_GetTypesByMimeType](#oh_utd_gettypesbymimetype) (const char \*mimeType, unsigned int \*count) | Obtains the uniform data types based on the MIME types.|
350| bool [OH_Utd_BelongsTo](#oh_utd_belongsto) (const char \*srcTypeId, const char \*destTypeId) | Checks whether a UTD belongs to the target UTD.|
351| bool [OH_Utd_IsLower](#oh_utd_islower) (const char \*srcTypeId, const char \*destTypeId) | Checks whether a UTD is a lower-level type of the target UTD. For example, **TYPE_SCRIPT** is a lower-level type of **SOURCE_CODE**, and **TYPE_SCRIPT** and **SOURCE_CODE** are lower-level types of **PLAIN_TEXT**.|
352| bool [OH_Utd_IsHigher](#oh_utd_ishigher) (const char \*srcTypeId, const char \*destTypeId) | Checks whether a UTD is a higher-level type of the target UTD. For example, **SOURCE_CODE** is a higher-level type of **TYPE_SCRIPT**, and **PLAIN_TEXT** is a higher-level type of **SOURCE_CODE** and **TYPE_SCRIPT**.|
353| bool [OH_Utd_Equals](#oh_utd_equals) ([OH_Utd](#oh_utd) \*utd1, [OH_Utd](#oh_utd) \*utd2) | Checks whether two UTDs are the same.|
354| void [OH_Utd_DestroyStringList](#oh_utd_destroystringlist) (const char \*\*list, unsigned int count) | Destroys a UTD string list.|
355
356
357## Macro Description
358
359### UDMF_METE_GENERAL_CONTENT_FORM
360
361```
362#define UDMF_METE_GENERAL_CONTENT_FORM   "general.content-form"
363```
364
365**Description**
366
367Defines the content widget type.<br>This type belongs to **OBJECT**.
368
369**Since**: 14
370
371### UDMF_KEY_BUFFER_LEN
372
373```
374#define UDMF_KEY_BUFFER_LEN   (512)
375```
376
377**Description**
378
379Specifies the minimum length of the buffer that holds the key (unique identifier) of a uniform data object.
380
381**Since**: 12
382
383
384### UDMF_META_AAC
385
386```
387#define UDMF_META_AAC   "general.aac"
388```
389
390**Description**
391
392Indicates AAC, which belongs to **AUDIO**.
393
394**Since**: 12
395
396
397### UDMF_META_AI_IMAGE
398
399```
400#define UDMF_META_AI_IMAGE   "com.adobe.illustrator.ai-image"
401```
402
403**Description**
404
405Indicates adobe Illustrator image (.ai), which belongs to **IMAGE**.
406
407**Since**: 12
408
409
410### UDMF_META_AIFC_AUDIO
411
412```
413#define UDMF_META_AIFC_AUDIO   "general.aifc-audio"
414```
415
416**Description**
417
418Indicates AIFC, which belongs to **AUDIO**.
419
420**Since**: 12
421
422
423### UDMF_META_AIFF
424
425```
426#define UDMF_META_AIFF   "general.aiff"
427```
428
429**Description**
430
431Indicates AIFF, which belongs to **AUDIO**.
432
433**Since**: 12
434
435
436### UDMF_META_ALAC
437
438```
439#define UDMF_META_ALAC   "general.alac"
440```
441
442**Description**
443
444Indicates ALAC, which belongs to **AUDIO**.
445
446**Since**: 12
447
448
449### UDMF_META_ARCHIVE
450
451```
452#define UDMF_META_ARCHIVE   "general.archive"
453```
454
455**Description**
456
457Indicates the generic archive file type, which belongs to **OBJECT**.
458
459**Since**: 12
460
461
462### UDMF_META_AU_AUDIO
463
464```
465#define UDMF_META_AU_AUDIO   "general.au-audio"
466```
467
468**Description**
469
470Indicates the AU format, which belongs to **AUDIO**.
471
472**Since**: 12
473
474
475### UDMF_META_AUDIO
476
477```
478#define UDMF_META_AUDIO   "general.audio"
479```
480
481**Description**
482
483Indicates the generic audio type, which belongs to **MEDIA**.
484
485**Since**: 12
486
487
488### UDMF_META_AVI
489
490```
491#define UDMF_META_AVI   "general.avi"
492```
493
494**Description**
495
496Indicates AVI, which belongs to **VIDEO**.
497
498**Since**: 12
499
500
501### UDMF_META_AZW
502
503```
504#define UDMF_META_AZW   "com.amazon.azw"
505```
506
507**Description**
508
509Indicates AZW, which belongs to **EBOOK**.
510
511**Since**: 12
512
513
514### UDMF_META_AZW3
515
516```
517#define UDMF_META_AZW3   "com.amazon.azw3"
518```
519
520**Description**
521
522Indicates AZW3, which belongs to **EBOOK**.
523
524**Since**: 12
525
526
527### UDMF_META_BMP
528
529```
530#define UDMF_META_BMP   "com.microsoft.bmp"
531```
532
533**Description**
534
535Indicates BMP, which belongs to **IMAGE**.
536
537**Since**: 12
538
539
540### UDMF_META_BZ2_ARCHIVE
541
542```
543#define UDMF_META_BZ2_ARCHIVE   "general.bz2-archive"
544```
545
546**Description**
547
548Indicates BZ2, which belongs to **ARCHIVE**.
549
550**Since**: 12
551
552
553### UDMF_META_C_HEADER
554
555```
556#define UDMF_META_C_HEADER   "general.c-header"
557```
558
559**Description**
560
561Indicates a header file in C, which belongs to **SOURCE_CODE**.
562
563**Since**: 12
564
565
566### UDMF_META_C_PLUS_PLUS_HEADER
567
568```
569#define UDMF_META_C_PLUS_PLUS_HEADER   "general.c-plus-plus-header"
570```
571
572**Description**
573
574Indicates a header file in C++, which belongs to **SOURCE_CODE**.
575
576**Since**: 12
577
578
579### UDMF_META_C_PLUS_PLUS_SOURCE
580
581```
582#define UDMF_META_C_PLUS_PLUS_SOURCE   "general.c-plus-plus-source"
583```
584
585**Description**
586
587Indicates the source code in C++, which belongs to **SOURCE_CODE**.
588
589**Since**: 12
590
591
592### UDMF_META_C_SOURCE
593
594```
595#define UDMF_META_C_SOURCE   "general.c-source"
596```
597
598**Description**
599
600Indicates the source code in C, which belongs to **SOURCE_CODE**.
601
602**Since**: 12
603
604
605### UDMF_META_CALENDAR
606
607```
608#define UDMF_META_CALENDAR   "general.calendar"
609```
610
611**Description**
612
613Indicates the generic calendar type, which belongs to **OBJECT**.
614
615**Since**: 12
616
617
618### UDMF_META_COMPOSITE_OBJECT
619
620```
621#define UDMF_META_COMPOSITE_OBJECT   "general.composite-object"
622```
623
624**Description**
625
626Indicates the generic composite content type. For example, a PDF file that contains text and image. This type belongs to **OBJECT**.
627
628**Since**: 12
629
630
631### UDMF_META_CONTACT
632
633```
634#define UDMF_META_CONTACT   "general.contact"
635```
636
637**Description**
638
639Indicates the generic contact type. This type belongs to **OBJECT**.
640
641**Since**: 12
642
643
644### UDMF_META_CSH_SCRIPT
645
646```
647#define UDMF_META_CSH_SCRIPT   "general.csh-script"
648```
649
650**Description**
651
652Indicates a C shell script, which belongs to **SHELL_SCRIPT**.
653
654**Since**: 12
655
656
657### UDMF_META_DATABASE
658
659```
660#define UDMF_META_DATABASE   "general.database"
661```
662
663**Description**
664
665Indicates the generic database file type, which belongs to **OBJECT**.
666
667**Since**: 12
668
669
670### UDMF_META_DIRECTORY
671
672```
673#define UDMF_META_DIRECTORY   "general.directory"
674```
675
676**Description**
677
678Indicates the generic directory type, which belongs to **ENTITY**.
679
680**Since**: 12
681
682
683### UDMF_META_DISK_IMAGE
684
685```
686#define UDMF_META_DISK_IMAGE   "general.disk-image"
687```
688
689**Description**
690
691Indicates the generic type of any file that can be mounted as a volume. This type belongs to **ARCHIVE**.
692
693**Since**: 12
694
695
696### UDMF_META_EBOOK
697
698```
699#define UDMF_META_EBOOK   "general.ebook"
700```
701
702**Description**
703
704Indicates the generic eBook file format, which belongs to **COMPOSITE_OBJECT**.
705
706**Since**: 12
707
708
709### UDMF_META_EFX_FAX
710
711```
712#define UDMF_META_EFX_FAX   "com.js.efx-fax"
713```
714
715**Description**
716
717Indicates the EFX file format, which belongs to **FAX**.
718
719**Since**: 12
720
721
722### UDMF_META_ENCAPSULATED_POSTSCRIPT
723
724```
725#define UDMF_META_ENCAPSULATED_POSTSCRIPT   "com.adobe.encapsulated-postscript"
726```
727
728**Description**
729
730Indicates encapsulated PostScript, which belongs to **POSTSCRIPT**.
731
732**Since**: 12
733
734
735### UDMF_META_ENTITY
736
737```
738#define UDMF_META_ENTITY   "general.entity"
739```
740
741**Description**
742
743Indicates the generic type that represents all physical storage types. It is used to define physical properties of a type. This type is uncategorized.
744
745**Since**: 12
746
747
748### UDMF_META_EPUB
749
750```
751#define UDMF_META_EPUB   "general.epub"
752```
753
754**Description**
755
756Indicates EPUB, which belongs to **EBOOK**.
757
758**Since**: 12
759
760
761### UDMF_META_EXCEL
762
763```
764#define UDMF_META_EXCEL   "com.microsoft.excel.xls"
765```
766
767**Description**
768
769Indicates Microsoft Excel, which belongs to **COMPOSITE_OBJECT**.
770
771**Since**: 12
772
773
774### UDMF_META_EXECUTABLE
775
776```
777#define UDMF_META_EXECUTABLE   "general.executable"
778```
779
780**Description**
781
782Indicates the generic type of all executable files, which belongs to **OBJECT**.
783
784**Since**: 12
785
786
787### UDMF_META_FAX
788
789```
790#define UDMF_META_FAX   "general.fax"
791```
792
793**Description**
794
795Indicates the generic fax type, which belongs to **IMAGE**.
796
797**Since**: 12
798
799
800### UDMF_META_FLAC
801
802```
803#define UDMF_META_FLAC   "general.flac"
804```
805
806**Description**
807
808Indicates FLAC, which belongs to **AUDIO**.
809
810**Since**: 12
811
812
813### UDMF_META_FLASHPIX_IMAGE
814
815```
816#define UDMF_META_FLASHPIX_IMAGE   "com.kodak.flashpix.image"
817```
818
819**Description**
820
821Indicates the FlashPix image format, which belongs to **IMAGE**.
822
823**Since**: 12
824
825
826### UDMF_META_FOLDER
827
828```
829#define UDMF_META_FOLDER   "general.folder"
830```
831
832**Description**
833
834Indicates the generic folder type, which belongs to **DIRECTORY**.
835
836**Since**: 12
837
838
839### UDMF_META_FONT
840
841```
842#define UDMF_META_FONT   "general.font"
843```
844
845**Description**
846
847Indicates the generic font type, which belongs to **OBJECT**.
848
849**Since**: 12
850
851
852### UDMF_META_GENERAL_FILE
853
854```
855#define UDMF_META_GENERAL_FILE   "general.file"
856```
857
858**Description**
859
860Indicates the generic file type, which belongs to **ENTITY**.
861
862**Since**: 12
863
864
865### UDMF_META_GENERAL_FILE_URI
866
867```
868#define UDMF_META_GENERAL_FILE_URI   "general.file-uri"
869```
870
871**Description**
872
873Indicates the file address type, which belongs to **TEXT**.
874
875**Since**: 13
876
877
878### UDMF_META_GNU_TAR_ARCHIVE
879
880```
881#define UDMF_META_GNU_TAR_ARCHIVE   "org.gnu.gnu-tar-archive"
882```
883
884**Description**
885
886Indicates GUN archive, which belongs to **ARCHIVE**.
887
888**Since**: 12
889
890
891### UDMF_META_GNU_ZIP_ARCHIVE
892
893```
894#define UDMF_META_GNU_ZIP_ARCHIVE   "org.gnu.gnu-zip-archive"
895```
896
897**Description**
898
899Indicates GZIP archive, which belongs to **ARCHIVE**.
900
901**Since**: 12
902
903
904### UDMF_META_GNU_ZIP_TAR_ARCHIVE
905
906```
907#define UDMF_META_GNU_ZIP_TAR_ARCHIVE   "org.gnu.gnu-zip-tar-archive"
908```
909
910**Description**
911
912Indicates GZIP TAR, which belongs to **ARCHIVE**.
913
914**Since**: 12
915
916
917### UDMF_META_HTML
918
919```
920#define UDMF_META_HTML   "general.html"
921```
922
923**Description**
924
925Indicates HTML, which belongs to **TEXT**.
926
927**Since**: 12
928
929
930### UDMF_META_HYPERLINK
931
932```
933#define UDMF_META_HYPERLINK   "general.hyperlink"
934```
935
936**Description**
937
938Indicates Hyperlink, which belongs to **TEXT**.
939
940**Since**: 12
941
942
943### UDMF_META_ICO
944
945```
946#define UDMF_META_ICO   "com.microsoft.ico"
947```
948
949**Description**
950
951Indicates Windows icon type, which belongs to **IMAGE**.
952
953**Since**: 12
954
955
956### UDMF_META_ICS
957
958```
959#define UDMF_META_ICS   "general.ics"
960```
961
962**Description**
963
964Indicates the ICS format, which belongs to **CALENDAR** and **TEXT**.
965
966**Since**: 12
967
968
969### UDMF_META_IMAGE
970
971```
972#define UDMF_META_IMAGE   "general.image"
973```
974
975**Description**
976
977Indicates the generic image type, which belongs to **MEDIA**.
978
979**Since**: 12
980
981
982### UDMF_META_JAVA_ARCHIVE
983
984```
985#define UDMF_META_JAVA_ARCHIVE   "com.sun.java-archive"
986```
987
988**Description**
989
990Indicates JAR (Java archive), which belongs to **ARCHIVE** and **EXECUTABLE**.
991
992**Since**: 12
993
994
995### UDMF_META_JAVA_SCRIPT
996
997```
998#define UDMF_META_JAVA_SCRIPT   "general.java-script"
999```
1000
1001**Description**
1002
1003Indicates JavaScript source code, which belongs to **SCRIPT**.
1004
1005**Since**: 12
1006
1007
1008### UDMF_META_JAVA_SOURCE
1009
1010```
1011#define UDMF_META_JAVA_SOURCE   "general.java-source"
1012```
1013
1014**Description**
1015
1016Indicates Java source code, which belongs to **SOURCE_CODE**.
1017
1018**Since**: 12
1019
1020
1021### UDMF_META_JFX_FAX
1022
1023```
1024#define UDMF_META_JFX_FAX   "com.j2.jfx-fax"
1025```
1026
1027**Description**
1028
1029Indicates the J2 jConnect fax file format, which belongs to **FAX**.
1030
1031**Since**: 12
1032
1033
1034### UDMF_META_JPEG
1035
1036```
1037#define UDMF_META_JPEG   "general.jpeg"
1038```
1039
1040**Description**
1041
1042Indicates JPEG, which belongs to **IMAGE**.
1043
1044**Since**: 12
1045
1046
1047### UDMF_META_KFX
1048
1049```
1050#define UDMF_META_KFX   "com.amazon.kfx"
1051```
1052
1053**Description**
1054
1055Indicates KFX, which belongs to **EBOOK**.
1056
1057**Since**: 12
1058
1059
1060### UDMF_META_LOCATION
1061
1062```
1063#define UDMF_META_LOCATION   "general.location"
1064```
1065
1066**Description**
1067
1068Indicates location data type, which belongs to **NAVIGATION**.
1069
1070**Since**: 12
1071
1072
1073### UDMF_META_MARKDOWN
1074
1075```
1076#define UDMF_META_MARKDOWN   "general.markdown"
1077```
1078
1079**Description**
1080
1081Indicates Markdown, which belongs to **PLAIN_TEXT**.
1082
1083**Since**: 12
1084
1085
1086### UDMF_META_MEDIA
1087
1088```
1089#define UDMF_META_MEDIA   "general.media"
1090```
1091
1092**Description**
1093
1094Indicates the generic media type, which belongs to **OBJECT**.
1095
1096**Since**: 12
1097
1098
1099### UDMF_META_MESSAGE
1100
1101```
1102#define UDMF_META_MESSAGE   "general.message"
1103```
1104
1105**Description**
1106
1107Indicates the generic message type, which belongs to **OBJECT**.
1108
1109**Since**: 12
1110
1111
1112### UDMF_META_MOBI
1113
1114```
1115#define UDMF_META_MOBI   "com.amazon.mobi"
1116```
1117
1118**Description**
1119
1120Indicates MOBI, which belongs to **EBOOK**.
1121
1122**Since**: 12
1123
1124
1125### UDMF_META_MP3
1126
1127```
1128#define UDMF_META_MP3   "general.mp3"
1129```
1130
1131**Description**
1132
1133Indicates MP3, which belongs to **AUDIO**.
1134
1135**Since**: 12
1136
1137
1138### UDMF_META_MPEG
1139
1140```
1141#define UDMF_META_MPEG   "general.mpeg"
1142```
1143
1144**Description**
1145
1146Indicates MPGE-1 or MPGE-2, which belongs to **VIDEO**.
1147
1148**Since**: 12
1149
1150
1151### UDMF_META_MPEG4
1152
1153```
1154#define UDMF_META_MPEG4   "general.mpeg-4"
1155```
1156
1157**Description**
1158
1159Indicates MPGE-4, which belongs to **VIDEO**.
1160
1161**Since**: 12
1162
1163
1164### UDMF_META_NAVIGATION
1165
1166```
1167#define UDMF_META_NAVIGATION   "general.navigation"
1168```
1169
1170**Description**
1171
1172Generic navigation data type.<br>This type belongs to **OBJECT**.
1173
1174**Since**: 12
1175
1176
1177### UDMF_META_OBJECT
1178
1179```
1180#define UDMF_META_OBJECT   "general.object"
1181```
1182
1183**Description**
1184
1185Indicates the generic type that represents all logical content types. It is used to describe the functional features of a type. This type is uncategorized.
1186
1187**Since**: 12
1188
1189
1190### UDMF_META_OGG
1191
1192```
1193#define UDMF_META_OGG   "general.ogg"
1194```
1195
1196**Description**
1197
1198OGG.<br>This type belongs to **AUDIO**.
1199
1200**Since**: 12
1201
1202
1203### UDMF_META_OPENDOCUMENT
1204
1205```
1206#define UDMF_META_OPENDOCUMENT   "org.oasis.opendocument"
1207```
1208
1209**Description**
1210
1211OpenDocument format for Office applications.<br>This type belongs to **ARCHIVE**.
1212
1213**Since**: 12
1214
1215
1216### UDMF_META_OPENDOCUMENT_FORMULA
1217
1218```
1219#define UDMF_META_OPENDOCUMENT_FORMULA   "org.oasis.opendocument.formula"
1220```
1221
1222**Description**
1223
1224OpenDocument format for formula.<br>This type belongs to **OPENDOCUMENT**.
1225
1226**Since**: 12
1227
1228
1229### UDMF_META_OPENDOCUMENT_GRAPHICS
1230
1231```
1232#define UDMF_META_OPENDOCUMENT_GRAPHICS   "org.oasis.opendocument.graphics"
1233```
1234
1235**Description**
1236
1237OpenDocument format for graphics.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.
1238
1239**Since**: 12
1240
1241
1242### UDMF_META_OPENDOCUMENT_PRESENTATION
1243
1244```
1245#define UDMF_META_OPENDOCUMENT_PRESENTATION   "org.oasis.opendocument.presentation"
1246```
1247
1248**Description**
1249
1250OpenDocument format for presentations.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.
1251
1252**Since**: 12
1253
1254
1255### UDMF_META_OPENDOCUMENT_SPREADSHEET
1256
1257```
1258#define UDMF_META_OPENDOCUMENT_SPREADSHEET   "org.oasis.opendocument.spreadsheet"
1259```
1260
1261**Description**
1262
1263OpenDocument format for spreadsheets.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.
1264
1265**Since**: 12
1266
1267
1268### UDMF_META_OPENDOCUMENT_TEXT
1269
1270```
1271#define UDMF_META_OPENDOCUMENT_TEXT   "org.oasis.opendocument.text"
1272```
1273
1274**Description**
1275
1276OpenDocument format for word processing (text) documents.<br>This type belongs to **OPENDOCUMENT** and **COMPOSITE_OBJECT**.
1277
1278**Since**: 12
1279
1280
1281### UDMF_META_OPENEXR_IMAGE
1282
1283```
1284#define UDMF_META_OPENEXR_IMAGE   "com.ilm.openexr-image"
1285```
1286
1287**Description**
1288
1289OpenXR image format.<br>This type belongs to **IMAGE**.
1290
1291**Since**: 12
1292
1293
1294### UDMF_META_OPENHARMONY_APP_ITEM
1295
1296```
1297#define UDMF_META_OPENHARMONY_APP_ITEM   "openharmony.app-item"
1298```
1299
1300**Description**
1301
1302Home screen icon defined for the system.<br>This type belongs to **OBJECT**.
1303
1304**Since**: 12
1305
1306
1307### UDMF_META_OPENHARMONY_ATOMIC_SERVICE
1308
1309```
1310#define UDMF_META_OPENHARMONY_ATOMIC_SERVICE   "openharmony.atomic-service"
1311```
1312
1313**Description**
1314
1315Atomic service type defined for the system.<br>This type belongs to **OBJECT**.
1316
1317**Since**: 12
1318
1319
1320### UDMF_META_OPENHARMONY_FORM
1321
1322```
1323#define UDMF_META_OPENHARMONY_FORM   "openharmony.form"
1324```
1325
1326**Description**
1327
1328Widget defined for the system.<br>This type belongs to **OBJECT**.
1329
1330**Since**: 12
1331
1332
1333### UDMF_META_OPENHARMONY_HAP
1334
1335```
1336#define UDMF_META_OPENHARMONY_HAP   "openharmony.hap"
1337```
1338
1339**Description**
1340
1341Ability package defined for the system.<br>This type belongs to **OPENHARMONY_PACKAGE**.
1342
1343**Since**: 12
1344
1345
1346### UDMF_META_OPENHARMONY_HDOC
1347
1348```
1349#define UDMF_META_OPENHARMONY_HDOC   "openharmony.hdoc"
1350```
1351
1352**Description**
1353
1354Memo format defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.
1355
1356**Since**: 12
1357
1358
1359### UDMF_META_OPENHARMONY_HINOTE
1360
1361```
1362#define UDMF_META_OPENHARMONY_HINOTE   "openharmony.hinote"
1363```
1364
1365**Description**
1366
1367Note format defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.
1368
1369**Since**: 12
1370
1371
1372### UDMF_META_OPENHARMONY_PACKAGE
1373
1374```
1375#define UDMF_META_OPENHARMONY_PACKAGE   "openharmony.package"
1376```
1377
1378**Description**
1379
1380Package (compressed folder) defined for the system.<br>This type belongs to **DIRECTORY**.
1381
1382**Since**: 12
1383
1384
1385### UDMF_META_OPENHARMONY_PIXEL_MAP
1386
1387```
1388#define UDMF_META_OPENHARMONY_PIXEL_MAP   "openharmony.pixel-map"
1389```
1390
1391**Description**
1392
1393Pixel map defined for the system.<br>This type belongs to **IMAGE**.
1394
1395**Since**: 12
1396
1397
1398### UDMF_META_OPENHARMONY_STYLED_STRING
1399
1400```
1401#define UDMF_META_OPENHARMONY_STYLED_STRING   "openharmony.styled-string"
1402```
1403
1404**Description**
1405
1406Style string type defined for the system.<br>This type belongs to **COMPOSITE_OBJECT**.
1407
1408**Since**: 12
1409
1410
1411### UDMF_META_OPENHARMONY_WANT
1412
1413```
1414#define UDMF_META_OPENHARMONY_WANT   "openharmony.want"
1415```
1416
1417**Description**
1418
1419Want defined for the system.<br>This type belongs to **OBJECT**.
1420
1421**Since**: 12
1422
1423
1424### UDMF_META_OPENTYPE_FONT
1425
1426```
1427#define UDMF_META_OPENTYPE_FONT   "general.opentype-font"
1428```
1429
1430**Description**
1431
1432Indicates the OpenType font format, which belongs to **FONT**.
1433
1434**Since**: 12
1435
1436
1437### UDMF_META_OPENXML
1438
1439```
1440#define UDMF_META_OPENXML   "org.openxmlformats.openxml"
1441```
1442
1443**Description**
1444
1445Indicates OpenXML, which belongs to **ARCHIVE**.
1446
1447**Since**: 12
1448
1449
1450### UDMF_META_PCM
1451
1452```
1453#define UDMF_META_PCM   "general.pcm"
1454```
1455
1456**Description**
1457
1458Indicates PCM, which belongs to **AUDIO**.
1459
1460**Since**: 12
1461
1462
1463### UDMF_META_PDF
1464
1465```
1466#define UDMF_META_PDF   "com.adobe.pdf"
1467```
1468
1469**Description**
1470
1471Indicates PDF, which belongs to **COMPOSITE_OBJECT**.
1472
1473**Since**: 12
1474
1475
1476### UDMF_META_PERL_SCRIPT
1477
1478```
1479#define UDMF_META_PERL_SCRIPT   "general.perl-script"
1480```
1481
1482**Description**
1483
1484Indicates a Perl script, which belongs to **SHELL_SCRIPT**.
1485
1486**Since**: 12
1487
1488
1489### UDMF_META_PHOTOSHOP_IMAGE
1490
1491```
1492#define UDMF_META_PHOTOSHOP_IMAGE   "com.adobe.photoshop-image"
1493```
1494
1495**Description**
1496
1497Indicates an Adobe Photoshop image, which belongs to **IMAGE**.
1498
1499**Since**: 12
1500
1501
1502### UDMF_META_PHP_SCRIPT
1503
1504```
1505#define UDMF_META_PHP_SCRIPT   "general.php-script"
1506```
1507
1508**Description**
1509
1510Indicates a PHP script, which belongs to **SHELL_SCRIPT**.
1511
1512**Since**: 12
1513
1514
1515### UDMF_META_PLAIN_TEXT
1516
1517```
1518#define UDMF_META_PLAIN_TEXT   "general.plain-text"
1519```
1520
1521**Description**
1522
1523Indicates text without specific encoding or identifier, which belongs to **TEXT**.
1524
1525**Since**: 12
1526
1527
1528### UDMF_META_PNG
1529
1530```
1531#define UDMF_META_PNG   "general.png"
1532```
1533
1534**Description**
1535
1536Indicates PNG, which belongs to **IMAGE**.
1537
1538**Since**: 12
1539
1540
1541### UDMF_META_PORTABLE_EXECUTABLE
1542
1543```
1544#define UDMF_META_PORTABLE_EXECUTABLE   "com.microsoft.portable-executable"
1545```
1546
1547**Description**
1548
1549Indicates the Microsoft Windows portable executable format, which belongs to **EXECUTABLE**.
1550
1551**Since**: 12
1552
1553
1554### UDMF_META_POSTSCRIPT
1555
1556```
1557#define UDMF_META_POSTSCRIPT   "com.adobe.postscript"
1558```
1559
1560**Description**
1561
1562Indicates PostScript, which belongs to **COMPOSITE_OBJECT**.
1563
1564**Since**: 12
1565
1566
1567### UDMF_META_POSTSCRIPT_FONT
1568
1569```
1570#define UDMF_META_POSTSCRIPT_FONT   "com.adobe.postscript-font"
1571```
1572
1573**Description**
1574
1575Indicates the PostScript font format, which belongs to **FONT**.
1576
1577**Since**: 12
1578
1579
1580### UDMF_META_POSTSCRIPT_PFA_FONT
1581
1582```
1583#define UDMF_META_POSTSCRIPT_PFA_FONT   "com.adobe.postscript-pfa-font"
1584```
1585
1586**Description**
1587
1588Indicates Adobe Type 1 font format, which belongs to **FONT**.
1589
1590**Since**: 12
1591
1592
1593### UDMF_META_POSTSCRIPT_PFB_FONT
1594
1595```
1596#define UDMF_META_POSTSCRIPT_PFB_FONT   "com.adobe.postscript-pfb-font"
1597```
1598
1599**Description**
1600
1601Indicates PostScript Font Binary font format, which belongs to **FONT**.
1602
1603**Since**: 12
1604
1605
1606### UDMF_META_PPT
1607
1608```
1609#define UDMF_META_PPT   "com.microsoft.powerpoint.ppt"
1610```
1611
1612**Description**
1613
1614Indicates Microsoft PowerPoint presentation format, which belongs to **COMPOSITE_OBJECT**.
1615
1616**Since**: 12
1617
1618
1619### UDMF_META_PRESENTATIONML_PRESENTATION
1620
1621```
1622#define UDMF_META_PRESENTATIONML_PRESENTATION   "org.openxmlformats.presentationml.presentation"
1623```
1624
1625**Description**
1626
1627Indicates PresentationML format, which belongs to **OPENXML** and **COMPOSITE_OBJECT**.
1628
1629**Since**: 12
1630
1631
1632### UDMF_META_PYTHON_SCRIPT
1633
1634```
1635#define UDMF_META_PYTHON_SCRIPT   "general.python-script"
1636```
1637
1638**Description**
1639
1640Indicates a Python script, which belongs to **SHELL_SCRIPT**.
1641
1642**Since**: 12
1643
1644
1645### UDMF_META_RAW_IMAGE
1646
1647```
1648#define UDMF_META_RAW_IMAGE   "general.raw-image"
1649```
1650
1651**Description**
1652
1653Indicates a raw image, which belongs to **IMAGE**.
1654
1655**Since**: 12
1656
1657
1658### UDMF_META_REALAUDIO
1659
1660```
1661#define UDMF_META_REALAUDIO   "com.real.realaudio"
1662```
1663
1664**Description**
1665
1666Indicates RealAudio, which belongs to **AUDIO**.
1667
1668**Since**: 12
1669
1670
1671### UDMF_META_REALMEDIA
1672
1673```
1674#define UDMF_META_REALMEDIA   "com.real.realmedia"
1675```
1676
1677**Description**
1678
1679Indicates RealMedia format, which belongs to **VIDEO**.
1680
1681**Since**: 12
1682
1683
1684### UDMF_META_RUBY_SCRIPT
1685
1686```
1687#define UDMF_META_RUBY_SCRIPT   "general.ruby-script"
1688```
1689
1690**Description**
1691
1692Indicates a Ruby script, which belongs to **SHELL_SCRIPT**.
1693
1694**Since**: 12
1695
1696
1697### UDMF_META_SCRIPT
1698
1699```
1700#define UDMF_META_SCRIPT   "general.script"
1701```
1702
1703**Description**
1704
1705Indicates the source code in any scripting language, which belongs to **SOURCE_CODE**.
1706
1707**Since**: 12
1708
1709
1710### UDMF_META_SD2_AUDIO
1711
1712```
1713#define UDMF_META_SD2_AUDIO   "com.digidesign.sd2-audio"
1714```
1715
1716**Description**
1717
1718Indicates SDII, which belongs to **AUDIO**.
1719
1720**Since**: 12
1721
1722
1723### UDMF_META_SGI_IMAGE
1724
1725```
1726#define UDMF_META_SGI_IMAGE   "com.sgi.sgi-image"
1727```
1728
1729**Description**
1730
1731Indicates SGI format, which belongs to **IMAGE**.
1732
1733**Since**: 12
1734
1735
1736### UDMF_META_SHELL_SCRIPT
1737
1738```
1739#define UDMF_META_SHELL_SCRIPT   "general.shell-script"
1740```
1741
1742**Description**
1743
1744Indicates a Shell script, which belongs to **SCRIPT**.
1745
1746**Since**: 12
1747
1748
1749### UDMF_META_SMIL
1750
1751```
1752#define UDMF_META_SMIL   "com.real.smil"
1753```
1754
1755**Description**
1756
1757Indicates SMIL, which belongs to **XML**.
1758
1759**Since**: 12
1760
1761
1762### UDMF_META_SOURCE_CODE
1763
1764```
1765#define UDMF_META_SOURCE_CODE   "general.source-code"
1766```
1767
1768**Description**
1769
1770Indicates the generic source code type, which belongs to **PLAIN_TEXT**.
1771
1772**Since**: 12
1773
1774
1775### UDMF_META_SPREADSHEETML_SHEET
1776
1777```
1778#define UDMF_META_SPREADSHEETML_SHEET   "org.openxmlformats.spreadsheetml.sheet"
1779```
1780
1781**Description**
1782
1783Indicates the SpreadsheetML format, which belongs to **OPENXML** and **COMPOSITE_OBJECT**.
1784
1785**Since**: 12
1786
1787
1788### UDMF_META_STUFFIT_ARCHIVE
1789
1790```
1791#define UDMF_META_STUFFIT_ARCHIVE   "com.allume.stuffit-archive"
1792```
1793
1794**Description**
1795
1796Indicates the Stuffit compression format (stuffit archive), which belongs to **ARCHIVE**.
1797
1798**Since**: 12
1799
1800
1801### UDMF_META_SUN_JAVA_CLASS
1802
1803```
1804#define UDMF_META_SUN_JAVA_CLASS   "com.sun.java-class"
1805```
1806
1807**Description**
1808
1809Indicates the Java class file format, which belongs to **EXECUTABLE**.
1810
1811**Since**: 12
1812
1813
1814### UDMF_META_SYMLINK
1815
1816```
1817#define UDMF_META_SYMLINK   "general.symlink"
1818```
1819
1820**Description**
1821
1822Indicates the generic symbolic type, which belongs to **ENTITY**.
1823
1824**Since**: 12
1825
1826
1827### UDMF_META_TAR_ARCHIVE
1828
1829```
1830#define UDMF_META_TAR_ARCHIVE   "general.tar-archive"
1831```
1832
1833**Description**
1834
1835Indicates TAR, which belongs to ARCHIVE.
1836
1837**Since**: 12
1838
1839
1840### UDMF_META_TEXT
1841
1842```
1843#define UDMF_META_TEXT   "general.text"
1844```
1845
1846**Description**
1847
1848Indicates the generic text type, which belongs to **OBJECT**.
1849
1850**Since**: 12
1851
1852
1853### UDMF_META_TGA_IMAGE
1854
1855```
1856#define UDMF_META_TGA_IMAGE   "com.truevision.tga-image"
1857```
1858
1859**Description**
1860
1861Indicates TGA, which belongs to **IMAGE**.
1862
1863**Since**: 12
1864
1865
1866### UDMF_META_TIFF
1867
1868```
1869#define UDMF_META_TIFF   "general.tiff"
1870```
1871
1872**Description**
1873
1874Indicates TIFF, which belongs to **IMAGE**.
1875
1876**Since**: 12
1877
1878
1879### UDMF_META_TRUETYPE_COLLECTION_FONT
1880
1881```
1882#define UDMF_META_TRUETYPE_COLLECTION_FONT   "general.truetype-collection-font"
1883```
1884
1885**Description**
1886
1887Indicates the TrueType Collection font format, which belongs to **FONT**.
1888
1889**Since**: 12
1890
1891
1892### UDMF_META_TRUETYPE_FONT
1893
1894```
1895#define UDMF_META_TRUETYPE_FONT   "general.truetype-font"
1896```
1897
1898**Description**
1899
1900Indicates the TrueType font format, which belongs to **FONT**.
1901
1902**Since**: 12
1903
1904
1905### UDMF_META_TYPE_SCRIPT
1906
1907```
1908#define UDMF_META_TYPE_SCRIPT   "general.type-script"
1909```
1910
1911**Description**
1912
1913Indicates TypeScript source code, which belongs to **SCRIPT**.
1914
1915**Since**: 12
1916
1917
1918### UDMF_META_VCARD
1919
1920```
1921#define UDMF_META_VCARD   "general.vcard"
1922```
1923
1924**Description**
1925
1926Indicates the generic electronic business card type, which belongs to **OBJECT**.
1927
1928**Since**: 12
1929
1930
1931### UDMF_META_VCS
1932
1933```
1934#define UDMF_META_VCS   "general.vcs"
1935```
1936
1937**Description**
1938
1939Indicates the VCS format, which belongs to **CALENDAR** and **TEXT**.
1940
1941**Since**: 12
1942
1943
1944### UDMF_META_VIDEO
1945
1946```
1947#define UDMF_META_VIDEO   "general.video"
1948```
1949
1950**Description**
1951
1952Indicates the generic video type, which belongs to **MEDIA**.
1953
1954**Since**: 12
1955
1956
1957### UDMF_META_VIDEO_3GPP
1958
1959```
1960#define UDMF_META_VIDEO_3GPP   "general.3gpp"
1961```
1962
1963**Description**
1964
1965Indicates 3GP (3GPP file format), which belongs to **VIDEO**.
1966
1967**Since**: 12
1968
1969
1970### UDMF_META_VIDEO_3GPP2
1971
1972```
1973#define UDMF_META_VIDEO_3GPP2   "general.3gpp2"
1974```
1975
1976**Description**
1977
1978Indicates 3G2 (3GPP2 file format), which belongs to **VIDEO**.
1979
1980**Since**: 12
1981
1982
1983### UDMF_META_WAVEFORM_AUDIO
1984
1985```
1986#define UDMF_META_WAVEFORM_AUDIO   "com.microsoft.waveform-audio"
1987```
1988
1989**Description**
1990
1991Indicates Windows Waveform, which belongs to **AUDIO**.
1992
1993**Since**: 12
1994
1995
1996### UDMF_META_WINDOWS_MEDIA_WAX
1997
1998```
1999#define UDMF_META_WINDOWS_MEDIA_WAX   "com.microsoft.windows-media-wax"
2000```
2001
2002**Description**
2003
2004Indicates Windows WAX, which belongs to **AUDIO**.
2005
2006**Since**: 12
2007
2008
2009### UDMF_META_WINDOWS_MEDIA_WM
2010
2011```
2012#define UDMF_META_WINDOWS_MEDIA_WM   "com.microsoft.windows-media-wm"
2013```
2014
2015**Description**
2016
2017Indicates Windows WM format, which belongs to **VIDEO**.
2018
2019**Since**: 12
2020
2021
2022### UDMF_META_WINDOWS_MEDIA_WMA
2023
2024```
2025#define UDMF_META_WINDOWS_MEDIA_WMA   "com.microsoft.windows-media-wma"
2026```
2027
2028**Description**
2029
2030Indicates Windows WMA, which belongs to **AUDIO**.
2031
2032**Since**: 12
2033
2034
2035### UDMF_META_WINDOWS_MEDIA_WMP
2036
2037```
2038#define UDMF_META_WINDOWS_MEDIA_WMP   "com.microsoft.windows-media-wmp"
2039```
2040
2041**Description**
2042
2043Indicates Windows WMP, which belongs to **VIDEO**.
2044
2045**Since**: 12
2046
2047
2048### UDMF_META_WINDOWS_MEDIA_WMV
2049
2050```
2051#define UDMF_META_WINDOWS_MEDIA_WMV   "com.microsoft.windows-media-wmv"
2052```
2053
2054**Description**
2055
2056Indicates Windows WMV, which belongs to **VIDEO**.
2057
2058**Since**: 12
2059
2060
2061### UDMF_META_WINDOWS_MEDIA_WMX
2062
2063```
2064#define UDMF_META_WINDOWS_MEDIA_WMX   "com.microsoft.windows-media-wmx"
2065```
2066
2067**Description**
2068
2069Indicates Windows WMX, which belongs to **VIDEO**.
2070
2071**Since**: 12
2072
2073
2074### UDMF_META_WINDOWS_MEDIA_WVX
2075
2076```
2077#define UDMF_META_WINDOWS_MEDIA_WVX   "com.microsoft.windows-media-wvx"
2078```
2079
2080**Description**
2081
2082Indicates Windows WVX, which belongs to **VIDEO**.
2083
2084**Since**: 12
2085
2086
2087### UDMF_META_WORD_DOC
2088
2089```
2090#define UDMF_META_WORD_DOC   "com.microsoft.word.doc"
2091```
2092
2093**Description**
2094
2095Indicates Microsoft Word, which belongs to **COMPOSITE_OBJECT**.
2096
2097**Since**: 12
2098
2099
2100### UDMF_META_WORDPROCESSINGML_DOCUMENT
2101
2102```
2103#define UDMF_META_WORDPROCESSINGML_DOCUMENT   "org.openxmlformats.wordprocessingml.document"
2104```
2105
2106**Description**
2107
2108Indicates WordProcessingML format, which belongs to **OPENXML** and **COMPOSITE_OBJECT**.
2109
2110**Since**: 12
2111
2112
2113### UDMF_META_XBITMAP_IMAGE
2114
2115```
2116#define UDMF_META_XBITMAP_IMAGE   "general.xbitmap-image"
2117```
2118
2119**Description**
2120
2121Indicates X BitMAP (XBM) used in the X Window system (X11), which belongs to **IMAGE**.
2122
2123**Since**: 12
2124
2125
2126### UDMF_META_XML
2127
2128```
2129#define UDMF_META_XML   "general.xml"
2130```
2131
2132**Description**
2133
2134Indicates XML, which belongs to **TEXT**.
2135
2136**Since**: 12
2137
2138
2139### UDMF_META_ZIP_ARCHIVE
2140
2141```
2142#define UDMF_META_ZIP_ARCHIVE   "general.zip-archive"
2143```
2144
2145**Description**
2146
2147Indicates ZIP, which belongs to **ARCHIVE**.
2148
2149**Since**: 12
2150
2151
2152## Type Description
2153
2154
2155### Udmf_ListenerStatus
2156
2157```
2158typedef enum Udmf_ListenerStatusUdmf_ListenerStatus
2159```
2160
2161**Description**
2162
2163Defines an enum for the status codes returned when data is obtained asynchronously.
2164
2165**Since**: 15
2166
2167
2168### Udmf_FileConflictOptions
2169
2170```
2171typedef enum Udmf_FileConflictOptionsUdmf_FileConflictOptions
2172```
2173
2174**Description**
2175
2176Defines an enum for the options used to resolve file copy conflicts.
2177
2178**Since**: 15
2179
2180### Udmf_ProgressIndicator
2181
2182```
2183typedef enum Udmf_ProgressIndicatorUdmf_ProgressIndicator
2184```
2185
2186**Description**
2187
2188Defines an enum for progress indicator options. You can use the default progress indicator as required.
2189
2190**Since**: 15
2191
2192### OH_Udmf_ProgressInfo
2193
2194```
2195typedef struct OH_Udmf_ProgressInfoOH_Udmf_ProgressInfo
2196```
2197
2198**Description**
2199
2200Defines a struct for progress information.
2201
2202**Since**: 15
2203
2204### OH_UdmfGetDataParams
2205
2206```
2207typedef struct OH_UdmfGetDataParamsOH_UdmfGetDataParams
2208```
2209
2210**Description**
2211
2212Defines a struct for the parameters used to obtain UDMF data asynchronously.
2213
2214**Since**: 15
2215
2216### OH_Udmf_DataProgressListener
2217
2218```
2219typedef void(* OH_Udmf_DataProgressListener) (OH_Udmf_ProgressInfo *progressInfo, OH_UdmfData *data)
2220```
2221
2222**Description**
2223
2224Defines the callback used to return the data retrieval progress information and data obtained.
2225
2226A null pointer is returned if the progress is not 100. The data obtained is returned only when the progress reaches 100.
2227
2228**Since**: 15
2229
2230**Parameters**
2231
2232| Name| Description|
2233| -------- | -------- |
2234| progressInfo | Progress information obtained.|
2235| data | Data obtained.|
2236
2237
2238### OH_UdsContentForm
2239
2240```
2241typedef struct OH_UdsContentForm OH_UdsContentForm
2242```
2243
2244**Description**
2245
2246Defines a struct for the uniform data of the content widget type.
2247
2248**Since**: 14
2249
2250### OH_UdmfData
2251
2252```
2253typedef struct OH_UdmfData OH_UdmfData
2254```
2255
2256**Description**
2257
2258Defines a struct for a uniform data object.
2259
2260**Since**: 12
2261
2262
2263### OH_UdmfProperty
2264
2265```
2266typedef struct OH_UdmfProperty OH_UdmfProperty
2267```
2268
2269**Description**
2270
2271Defines a struct for a data record property in a uniform data object.
2272
2273**Since**: 12
2274
2275
2276### OH_UdmfRecord
2277
2278```
2279typedef struct OH_UdmfRecord OH_UdmfRecord
2280```
2281
2282**Description**
2283
2284Defines a struct for a data record in a uniform data object.
2285
2286**Since**: 12
2287
2288
2289### OH_UdmfRecordProvider
2290
2291```
2292typedef struct OH_UdmfRecordProvider OH_UdmfRecordProvider
2293```
2294
2295**Description**
2296
2297Represents the data record provider in a uniform data object.
2298
2299**Since**: 13
2300
2301
2302### OH_UdmfRecordProvider_GetData
2303
2304```
2305typedef void*(* OH_UdmfRecordProvider_GetData) (void *context, const char *type)
2306```
2307
2308**Description**
2309
2310Defines a callback function used to obtain data by type. This callback will be invoked to return the data obtained from **OH_UdmfRecord**.
2311
2312**Since**: 13
2313
2314**Parameters**
2315
2316| Name| Description|
2317| -------- | -------- |
2318| context | Pointer to the context set by [OH_UdmfRecordProvider_SetData](#oh_udmfrecordprovider_setdata).|
2319| type | Pointer to the type of the data to obtain. For details, see [udmf_meta.h](udmf__meta_8h.md).|
2320
2321**Returns**
2322
2323Uniform data obtained.
2324
2325
2326### OH_UdsAppItem
2327
2328```
2329typedef struct OH_UdsAppItem OH_UdsAppItem
2330```
2331
2332**Description**
2333
2334Defines a struct for the uniform data of the home screen icon type.
2335
2336**Since**: 12
2337
2338
2339### OH_UdsArrayBuffer
2340
2341```
2342typedef struct OH_UdsArrayBuffer OH_UdsArrayBuffer
2343```
2344
2345**Description**
2346
2347Defines a struct for the ArrayBuffer type.
2348
2349**Since**: 13
2350
2351
2352### OH_UdsFileUri
2353
2354```
2355typedef struct OH_UdsFileUri OH_UdsFileUri
2356```
2357
2358**Description**
2359
2360Defines a struct for the file URI type.
2361
2362**Since**: 13
2363
2364
2365### OH_UdsHtml
2366
2367```
2368typedef struct OH_UdsHtml OH_UdsHtml
2369```
2370
2371**Description**
2372
2373Defines a struct for the uniform data of the Hypertext Markup Language (HTML) type.
2374
2375**Since**: 12
2376
2377
2378### OH_UdsHyperlink
2379
2380```
2381typedef struct OH_UdsHyperlink OH_UdsHyperlink
2382```
2383
2384**Description**
2385
2386Defines a struct for the uniform data of the hyperlink type.
2387
2388**Since**: 12
2389
2390
2391### OH_UdsPixelMap
2392
2393```
2394typedef struct OH_UdsPixelMap OH_UdsPixelMap
2395```
2396
2397**Description**
2398
2399Defines a struct for the pixel map type.
2400
2401**Since**: 13
2402
2403
2404### OH_UdsPlainText
2405
2406```
2407typedef struct OH_UdsPlainText OH_UdsPlainText
2408```
2409
2410**Description**
2411
2412Defines a struct for the uniform data of the plaintext type.
2413
2414**Since**: 12
2415
2416
2417### OH_Utd
2418
2419```
2420typedef struct OH_Utd OH_Utd
2421```
2422
2423**Description**
2424
2425Defines a struct for a UTD.
2426
2427**Since**: 12
2428
2429
2430### Udmf_ErrCode
2431
2432```
2433typedef enum Udmf_ErrCode Udmf_ErrCode
2434```
2435
2436**Description**
2437
2438Defines an enum for error codes.
2439
2440**Since**: 12
2441
2442
2443### Udmf_Intention
2444
2445```
2446typedef enum Udmf_Intention Udmf_Intention
2447```
2448
2449**Description**
2450
2451Defines an enum for UDMF data channel types.
2452
2453**Since**: 12
2454
2455
2456### Udmf_ShareOption
2457
2458```
2459typedef enum Udmf_ShareOption Udmf_ShareOption
2460```
2461
2462**Description**
2463
2464Defines an enum for the scopes of the uniform data to be used on a device.
2465
2466**Since**: 12
2467
2468
2469### UdmfData_Finalize
2470
2471```
2472typedef void(* UdmfData_Finalize) (void *context)
2473```
2474
2475**Description**
2476
2477Defines a callback function used to release the context. This callback is invoked when the **OH_UdmfRecordProvider** instance is destroyed.
2478
2479**Since**: 13
2480
2481**Parameters**
2482
2483| Name| Description|
2484| -------- | -------- |
2485| context | Pointer to the context to release.|
2486
2487
2488## Enum Description
2489
2490### Udmf_ListenerStatus
2491
2492```
2493enum Udmf_ListenerStatus
2494```
2495
2496**Description**
2497
2498Enumerates the status codes returned when data is obtained asynchronously.
2499
2500**Since**: 15
2501
2502| Value| Description|
2503| -------- | -------- |
2504| UDMF_FINISHED | Data is obtained successfully.|
2505| UDMF_PROCESSING | The data retrieval task is being processed.|
2506| UDMF_CANCELED | The data retrieval task is canceled.|
2507| UDMF_INNER_ERROR | An internal error occurs.|
2508| UDMF_INVALID_PARAMETERS | Invalid parameters are detected.|
2509| UDMF_DATA_NOT_FOUND | No data is obtained.|
2510| UDMF_SYNC_FAILED | An error occurs during data synchronization.|
2511| UDMF_COPY_FILE_FAILED | Failed to copy the file.|
2512
2513### Udmf_FileConflictOptions
2514
2515```
2516enum Udmf_FileConflictOptions
2517```
2518
2519**Description**
2520
2521Enumerates the options used to resolve file copy conflicts.
2522
2523**Since**: 15
2524
2525| Value| Description|
2526| -------- | -------- |
2527| UDMF_OVERWRITE | Overwrite the file with the same name in the destination directory. This is the default value.|
2528| UDMF_SKIP | Skip the file if there is a file with the same name in the destination directory.|
2529
2530### Udmf_ProgressIndicator
2531
2532```
2533enum Udmf_ProgressIndicator
2534```
2535
2536**Description**
2537
2538Enumerates the progress indicator options. You can use the default progress indicator as required.
2539
2540**Since**: 15
2541
2542| Value| Description|
2543| -------- | -------- |
2544| UDMF_NONE | Do not use the default progress indicator.|
2545| UDMF_DEFAULT | Use the default progress indicator. If data is obtained within 500 ms, the default progress bar is not started.|
2546
2547### Udmf_ErrCode
2548
2549```
2550enum Udmf_ErrCode
2551```
2552
2553**Description**
2554
2555Enumerates the error codes.
2556
2557**Since**: 12
2558
2559| Value| Description|
2560| -------- | -------- |
2561| UDMF_E_OK | The operation is successful.|
2562| UDMF_ERR | Common error.|
2563| UDMF_E_INVALID_PARAM | Invalid parameter.|
2564
2565
2566### Udmf_Intention
2567
2568```
2569enum Udmf_Intention
2570```
2571
2572**Description**
2573
2574Enumerates the UDMF data channel types.
2575
2576**Since**: 12
2577
2578| Value| Description|
2579| -------- | -------- |
2580| UDMF_INTENTION_DRAG | Channel for dragging data.|
2581| UDMF_INTENTION_PASTEBOARD | Channel for clipboard data.|
2582
2583
2584### Udmf_ShareOption
2585
2586```
2587enum Udmf_ShareOption
2588```
2589
2590**Description**
2591
2592Enumerates the scopes of the uniform data to be used on a device.
2593
2594**Since**: 12
2595
2596| Value| Description|
2597| -------- | -------- |
2598| SHARE_OPTIONS_INVALID | Invalid use.|
2599| SHARE_OPTIONS_IN_APP | Use the uniform data only in the same application of a device.|
2600| SHARE_OPTIONS_CROSS_APP | Use the uniform data across applications of a device.|
2601
2602
2603## Function Description
2604
2605### OH_UdmfProgressInfo_GetProgress()
2606
2607```
2608int OH_UdmfProgressInfo_GetProgress (OH_Udmf_ProgressInfo* progressInfo)
2609```
2610
2611**Description**
2612
2613Obtains the progress information from [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).
2614
2615**Since**: 15
2616
2617**Parameters**
2618
2619| Name| Description|
2620| -------- | -------- |
2621| progressInfo | [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).|
2622
2623**Returns**
2624
2625Progress obtained, in percentage.
2626
2627**See**
2628
2629[OH_Udmf_ProgressInfo](#oh_udmf_progressinfo)
2630
2631### OH_UdmfProgressInfo_GetStatus()
2632
2633```
2634int OH_UdmfProgressInfo_GetStatus (OH_Udmf_ProgressInfo* progressInfo)
2635```
2636
2637**Description**
2638
2639Obtains the status information from [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).
2640
2641**Since**: 15
2642
2643**Parameters**
2644
2645| Name| Description|
2646| -------- | -------- |
2647| progressInfo | [OH_Udmf_ProgressInfo](#oh_udmf_progressinfo).|
2648
2649**Returns**
2650
2651Status information obtained.
2652
2653**See**
2654
2655[OH_Udmf_ProgressInfo](#oh_udmf_progressinfo)
2656
2657[Udmf_ListenerStatus](#udmf_listenerstatus)
2658
2659### OH_UdmfGetDataParams_Create()
2660
2661```
2662OH_UdmfGetDataParams* OH_UdmfGetDataParams_Create ()
2663```
2664
2665### OH_UdmfGetDataParams_Destroy()
2666
2667```
2668void OH_UdmfGetDataParams_Destroy (OH_UdmfGetDataParams* pThis)
2669```
2670
2671**Description**
2672
2673Destroys an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.
2674
2675**Since**: 15
2676
2677**Parameters**
2678
2679| Name| Description|
2680| -------- | -------- |
2681| pThis | Pointer to the [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance to destroy.|
2682
2683**See**
2684
2685[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2686
2687
2688**Description**
2689
2690Creates an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance for asynchronously obtaining UDMF data.
2691
2692If this pointer is no longer required, use [OH_UdmfGetDataParams_Destroy](#oh_udmfgetdataparams_destroy) to destroy it. Otherwise, memory leaks may occur.
2693
2694**Since**: 15
2695
2696**Returns**
2697
2698Returns a pointer to the [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance created if the operation is successful; returns **nullptr** otherwise.
2699
2700**See**
2701
2702[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2703
2704### OH_UdmfGetDataParams_SetDestUri()
2705
2706```
2707void OH_UdmfGetDataParams_SetDestUri (OH_UdmfGetDataParams* params, const char* destUri )
2708```
2709
2710**Description**
2711
2712Sets the destination directory in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.
2713
2714If the destination directory is set, data of the file type will be copied to the specified directory. The file type data obtained in the callback will be replaced with the URI of the destination directory.
2715
2716If the destination directory is not specified, the file will not be copied. The file type data obtained in the callback is the URI of the source directory.
2717
2718If the application involves complex file processing or files need to be copied to multiple directories, you are advised to leave this parameter unspecified and let the application to handle the file copy.
2719
2720**Since**: 15
2721
2722**Parameters**
2723
2724| Name| Description|
2725| -------- | -------- |
2726| params | Pointer to the target [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
2727| destUri | Destination directory to set.|
2728
2729**See**
2730
2731[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2732
2733### OH_UdmfGetDataParams_SetFileConflictOptions()
2734
2735```
2736void OH_UdmfGetDataParams_SetFileConflictOptions (OH_UdmfGetDataParams* params, const Udmf_FileConflictOptions options )
2737```
2738
2739**Description**
2740
2741Sets the policy for resolving file conflicts in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.
2742
2743**Since**: 15
2744
2745**Parameters**
2746
2747| Name| Description|
2748| -------- | -------- |
2749| params | Pointer to the target [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
2750| options | Policy to set.|
2751
2752**See**
2753
2754[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2755
2756[Udmf_FileConflictOptions](#udmf_fileconflictoptions)
2757
2758### OH_UdmfGetDataParams_SetProgressIndicator()
2759
2760```
2761void OH_UdmfGetDataParams_SetProgressIndicator (OH_UdmfGetDataParams* params, const Udmf_ProgressIndicator progressIndicator )
2762```
2763
2764**Description**
2765
2766Sets the progress indicator in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.
2767
2768**Since**: 15
2769
2770**Parameters**
2771
2772| Name| Description|
2773| -------- | -------- |
2774| params | Pointer to the target [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
2775| progressIndicator | Whether to use the default progress indicator.|
2776
2777**See**
2778
2779[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2780
2781[Udmf_ProgressIndicator](#udmf_progressindicator)
2782
2783### OH_UdmfGetDataParams_SetDataProgressListener()
2784
2785```
2786void OH_UdmfGetDataParams_SetDataProgressListener (OH_UdmfGetDataParams* params, const OH_Udmf_DataProgressListener dataProgressListener )
2787```
2788
2789**Description**
2790
2791Sets the callback used to return the data obtained in an [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.
2792
2793**Since**: 15
2794
2795**Parameters**
2796
2797| Name| Description|
2798| -------- | -------- |
2799| params | Pointer to the target [OH_UdmfGetDataParams](#oh_udmfgetdataparams) instance.|
2800| dataProgressListener | Callback to set.|
2801
2802**See**
2803
2804[OH_UdmfGetDataParams](#oh_udmfgetdataparams)
2805
2806[OH_Udmf_DataProgressListener](#oh_udmf_dataprogresslistener)
2807
2808### OH_UdmfRecord_AddContentForm()
2809
2810```
2811int OH_UdmfRecord_AddContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )
2812```
2813
2814**Description**
2815
2816Adds data of the [OH_UdsContentForm](#oh_udscontentform) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
2817
2818**Since**: 14
2819
2820**Parameters**
2821
2822| Name| Description|
2823| -------- | -------- |
2824| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
2825| contentForm | Pointer to the [OH_UdsContentForm](#oh_udscontentform) instance to add.|
2826
2827**Returns**
2828
2829Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
2830
2831**See**
2832
2833[OH_UdmfRecord](#oh_udmfrecord)
2834
2835[OH_UdsContentForm](#oh_udscontentform)
2836
2837[Udmf_ErrCode](#udmf_errcode)
2838
2839
2840### OH_UdmfRecord_GetContentForm()
2841
2842```
2843int OH_UdmfRecord_GetContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )
2844```
2845
2846**Description**
2847
2848Obtains data of the [OH_UdsContentForm](#oh_udscontentform) type from an [OH_UdmfRecord](#oh_udmfrecord) instance.
2849
2850**Since**: 14
2851
2852**Parameters**
2853
2854| Name| Description|
2855| -------- | -------- |
2856| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
2857| contentForm | Pointer to the [OH_UdsContentForm](#oh_udscontentform) instance obtained.|
2858
2859**Returns**
2860
2861Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
2862
2863**See**
2864
2865[OH_UdmfRecord](#oh_udmfrecord)
2866
2867[OH_UdsContentForm](#oh_udscontentform)
2868
2869[Udmf_ErrCode](#udmf_errcode)
2870
2871
2872### OH_UdsContentForm_Create()
2873
2874```
2875OH_UdsContentForm* OH_UdsContentForm_Create ()
2876```
2877
2878**Description**
2879
2880Creates an [OH_UdsContentForm](#oh_udscontentform) instance and a pointer to it.
2881
2882**Since**: 14
2883
2884**Returns**
2885
2886Returns a pointer to the [OH_UdsContentForm](#oh_udscontentform) instance created if the operation is successful; return **nullptr** otherwise.
2887
2888**See**
2889
2890[OH_UdsContentForm](#oh_udscontentform)
2891
2892
2893### OH_UdsContentForm_Destroy()
2894
2895```
2896void OH_UdsContentForm_Destroy (OH_UdsContentForm* pThis)
2897```
2898
2899**Description**
2900
2901Destroys an [OH_UdsContentForm](#oh_udscontentform) instance.
2902
2903**Since**: 14
2904
2905**Parameters**
2906
2907| Name| Description|
2908| -------- | -------- |
2909| pThis | Pointer to the [OH_UdsContentForm](#oh_udscontentform) instance to destroy.|
2910
2911**See**
2912
2913[OH_UdsContentForm](#oh_udscontentform)
2914
2915
2916### OH_UdsContentForm_GetAppIcon()
2917
2918```
2919int OH_UdsContentForm_GetAppIcon (OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len )
2920```
2921
2922**Description**
2923
2924Obtains the application icon data from an [OH_UdsContentForm](#oh_udscontentform) instance.
2925
2926**Since**: 14
2927
2928**Parameters**
2929
2930| Name| Description|
2931| -------- | -------- |
2932| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
2933| appIcon | Double pointer to the binary application icon data obtained.|
2934| len | Pointer to the length of the binary application icon data obtained.|
2935
2936**Returns**
2937
2938Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in. <br>Returns **UDMF_ERR** if an internal system error occurs.
2939
2940**See**
2941
2942[OH_UdsContentForm](#oh_udscontentform)
2943
2944[Udmf_ErrCode](#udmf_errcode)
2945
2946
2947### OH_UdsContentForm_GetAppName()
2948
2949```
2950const char* OH_UdsContentForm_GetAppName (OH_UdsContentForm* pThis)
2951```
2952
2953**Description**
2954
2955Obtains the application name from an [OH_UdsContentForm](#oh_udscontentform) instance.
2956
2957**Since**: 14
2958
2959**Parameters**
2960
2961| Name| Description|
2962| -------- | -------- |
2963| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
2964
2965**Returns**
2966
2967Returns the pointer to the application name obtained if the operation is successful; returns <b>nullptr</b> otherwise.
2968
2969**See**
2970
2971[OH_UdsContentForm](#oh_udscontentform)
2972
2973
2974### OH_UdsContentForm_GetDescription()
2975
2976```
2977const char* OH_UdsContentForm_GetDescription (OH_UdsContentForm* pThis)
2978```
2979
2980**Description**
2981
2982Obtains the description from an [OH_UdsContentForm](#oh_udscontentform) instance.
2983
2984**Since**: 14
2985
2986**Parameters**
2987
2988| Name| Description|
2989| -------- | -------- |
2990| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
2991
2992**Returns**
2993
2994Returns the pointer to the description string obtained if the operation is successful; returns **nullptr** otherwise.
2995
2996**See**
2997
2998[OH_UdsContentForm](#oh_udscontentform)
2999
3000
3001### OH_UdsContentForm_GetLinkUri()
3002
3003```
3004const char* OH_UdsContentForm_GetLinkUri (OH_UdsContentForm* pThis)
3005```
3006
3007**Description**
3008
3009Obtains the hyperlink information from an [OH_UdsContentForm](#oh_udscontentform) instance.
3010
3011**Since**: 14
3012
3013**Parameters**
3014
3015| Name| Description|
3016| -------- | -------- |
3017| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3018
3019**Returns**
3020
3021Returns the pointer to the hyperlink obtained if the operation is successful; returns <b>nullptr</b> otherwise.
3022
3023**See**
3024
3025[OH_UdsContentForm](#oh_udscontentform)
3026
3027
3028### OH_UdsContentForm_GetThumbData()
3029
3030```
3031int OH_UdsContentForm_GetThumbData (OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len )
3032```
3033
3034**Description**
3035
3036Obtains image data from an [OH_UdsContentForm](#oh_udscontentform) instance.
3037
3038**Since**: 14
3039
3040**Parameters**
3041
3042| Name| Description|
3043| -------- | -------- |
3044| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3045| thumbData | Double pointer to the binary image data obtained.|
3046| len | Pointer to the length of the binary image data obtained.|
3047
3048**Returns**
3049
3050Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in. <br>Returns **UDMF_ERR** if an internal system error occurs.
3051
3052**See**
3053
3054[OH_UdsContentForm](#oh_udscontentform)
3055
3056[Udmf_ErrCode](#udmf_errcode)
3057
3058
3059### OH_UdsContentForm_GetTitle()
3060
3061```
3062const char* OH_UdsContentForm_GetTitle (OH_UdsContentForm* pThis)
3063```
3064
3065**Description**
3066
3067Obtains the title from an [OH_UdsContentForm](#oh_udscontentform) instance.
3068
3069**Since**: 14
3070
3071**Parameters**
3072
3073| Name| Description|
3074| -------- | -------- |
3075| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3076
3077**Returns**
3078
3079Returns the pointer to the title string obtained if the operation is successful; returns **nullptr** otherwise.
3080
3081**See**
3082
3083[OH_UdsContentForm](#oh_udscontentform)
3084
3085
3086### OH_UdsContentForm_GetType()
3087
3088```
3089const char* OH_UdsContentForm_GetType (OH_UdsContentForm* pThis)
3090```
3091
3092**Description**
3093
3094Obtains the type ID from an [OH_UdsContentForm](#oh_udscontentform) instance.
3095
3096**Since**: 14
3097
3098**Parameters**
3099
3100| Name| Description|
3101| -------- | -------- |
3102| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3103
3104**Returns**
3105
3106Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
3107
3108**See**
3109
3110[OH_UdsContentForm](#oh_udscontentform)
3111
3112
3113### OH_UdsContentForm_SetAppIcon()
3114
3115```
3116int OH_UdsContentForm_SetAppIcon (OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len )
3117```
3118
3119**Description**
3120
3121Sets the application icon data for an [OH_UdsContentForm](#oh_udscontentform) instance.
3122
3123**Since**: 14
3124
3125**Parameters**
3126
3127| Name| Description|
3128| -------- | -------- |
3129| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3130| appIcon | Pointer to the binary application icon data to set.|
3131| len | Length of the binary application icon data to set.|
3132
3133**Returns**
3134
3135Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3136
3137**See**
3138
3139[OH_UdsContentForm](#oh_udscontentform)
3140
3141[Udmf_ErrCode](#udmf_errcode)
3142
3143
3144### OH_UdsContentForm_SetAppName()
3145
3146```
3147int OH_UdsContentForm_SetAppName (OH_UdsContentForm* pThis, const char* appName )
3148```
3149
3150**Description**
3151
3152Sets the application name for an [OH_UdsContentForm](#oh_udscontentform) instance.
3153
3154**Since**: 14
3155
3156**Parameters**
3157
3158| Name| Description|
3159| -------- | -------- |
3160| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3161| appName | Pointer to the application name to set.|
3162
3163**Returns**
3164
3165Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3166
3167**See**
3168
3169[OH_UdsContentForm](#oh_udscontentform)
3170
3171[Udmf_ErrCode](#udmf_errcode)
3172
3173
3174### OH_UdsContentForm_SetDescription()
3175
3176```
3177int OH_UdsContentForm_SetDescription (OH_UdsContentForm* pThis, const char* description )
3178```
3179
3180**Description**
3181
3182Sets the description for an [OH_UdsContentForm](#oh_udscontentform) instance.
3183
3184**Since**: 14
3185
3186**Parameters**
3187
3188| Name| Description|
3189| -------- | -------- |
3190| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3191| description | Pointer to the description to set.|
3192
3193**Returns**
3194
3195Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3196
3197**See**
3198
3199[OH_UdsContentForm](#oh_udscontentform)
3200
3201[Udmf_ErrCode](#udmf_errcode)
3202
3203
3204### OH_UdsContentForm_SetLinkUri()
3205
3206```
3207int OH_UdsContentForm_SetLinkUri (OH_UdsContentForm* pThis, const char* linkUri )
3208```
3209
3210**Description**
3211
3212Sets the hyperlink data for an [OH_UdsContentForm](#oh_udscontentform) instance.
3213
3214**Since**: 14
3215
3216**Parameters**
3217
3218| Name| Description|
3219| -------- | -------- |
3220| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3221| linkUri | Pointer to the hyperlink to set.|
3222
3223**Returns**
3224
3225Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3226
3227**See**
3228
3229[OH_UdsContentForm](#oh_udscontentform)
3230
3231[Udmf_ErrCode](#udmf_errcode)
3232
3233
3234### OH_UdsContentForm_SetThumbData()
3235
3236```
3237int OH_UdsContentForm_SetThumbData (OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len )
3238```
3239
3240**Description**
3241
3242Sets the image data for an [OH_UdsContentForm](#oh_udscontentform) instance.
3243
3244**Since**: 14
3245
3246**Parameters**
3247
3248| Name| Description|
3249| -------- | -------- |
3250| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3251| thumbData | Pointer to the binary image data to set.|
3252| len | Length of the binary image data to set.|
3253
3254**Returns**
3255
3256Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3257
3258**See**
3259
3260[OH_UdsContentForm](#oh_udscontentform)
3261
3262[Udmf_ErrCode](#udmf_errcode)
3263
3264
3265### OH_UdsContentForm_SetTitle()
3266
3267```
3268int OH_UdsContentForm_SetTitle (OH_UdsContentForm* pThis, const char* title )
3269```
3270
3271**Description**
3272
3273Sets the title for an [OH_UdsContentForm](#oh_udscontentform) instance.
3274
3275**Since**: 14
3276
3277**Parameters**
3278
3279| Name| Description|
3280| -------- | -------- |
3281| pThis | Pointer to the target [OH_UdsContentForm](#oh_udscontentform) instance.|
3282| title | Pointer to the title to set.|
3283
3284**Returns**
3285
3286Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3287
3288**See**
3289
3290[OH_UdsContentForm](#oh_udscontentform)
3291
3292[Udmf_ErrCode](#udmf_errcode)
3293
3294
3295### OH_Udmf_GetUnifiedData()
3296
3297```
3298int OH_Udmf_GetUnifiedData (const char* key, Udmf_Intention intention, OH_UdmfData* unifiedData )
3299```
3300
3301**Description**
3302
3303Obtains an [OH_UdmfData](#oh_udmfdata) instance from the UDMF database.
3304
3305**Since**: 12
3306
3307**Parameters**
3308
3309| Name| Description|
3310| -------- | -------- |
3311| key | Pointer to the identifier of the data in the database.|
3312| intention | Type of the data channel. For details, see [Udmf_Intent]( #udmf_intention).|
3313| unifiedData | Pointer to the [OH_UdmfData](#oh_udmfdata) obtained.|
3314
3315**Returns**
3316
3317Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3318
3319**See**
3320
3321[OH_UdmfProperty](#oh_udmfproperty)
3322
3323[Udmf_Intention](#udmf_intention)
3324
3325[Udmf_ErrCode](#udmf_errcode)
3326
3327
3328### OH_Udmf_SetUnifiedData()
3329
3330```
3331int OH_Udmf_SetUnifiedData (Udmf_Intention intention, OH_UdmfData* unifiedData, char* key, unsigned int keyLen )
3332```
3333
3334**Description**
3335
3336Sets an [OH_UdmfData](#oh_udmfdata) instance in the UDMF database.
3337
3338**Since**: 12
3339
3340**Parameters**
3341
3342| Name| Description|
3343| -------- | -------- |
3344| intention | Type of the data channel. For details, see [Udmf_Intent]( #udmf_intention).|
3345| unifiedData | Pointer to the [OH_UdmfData](#oh_udmfdata) data to set.|
3346| key | Pointer to the key that uniquely identifies the data in the database.|
3347| keyLen | Length of the key. The memory size must be greater than or equal to 512 bytes.|
3348
3349**Returns**
3350
3351Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3352
3353**See**
3354
3355[OH_UdmfProperty](#oh_udmfproperty)
3356
3357[Udmf_Intention](#udmf_intention)
3358
3359[Udmf_ErrCode](#udmf_errcode)
3360
3361
3362### OH_UdmfData_AddRecord()
3363
3364```
3365int OH_UdmfData_AddRecord (OH_UdmfData* pThis, OH_UdmfRecord* record )
3366```
3367
3368**Description**
3369
3370Adds an [OH_UdmfRecord](#oh_udmfrecord) to an [OH_UdmfData](#oh_udmfdata) instance.
3371
3372**Since**: 12
3373
3374**Parameters**
3375
3376| Name| Description|
3377| -------- | -------- |
3378| pThis | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3379| record | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
3380
3381**Returns**
3382
3383Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3384
3385**See**
3386
3387[OH_UdmfData](#oh_udmfdata)
3388
3389[Udmf_ErrCode](#udmf_errcode)
3390
3391
3392### OH_UdmfData_Create()
3393
3394```
3395OH_UdmfData* OH_UdmfData_Create ()
3396```
3397
3398**Description**
3399
3400Creates an [OH_UdmfData](#oh_udmfdata) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfData_Destroy](#oh_udmfdata_destroy) to destroy it. Otherwise, memory leaks may occur.
3401
3402**Since**: 12
3403
3404**Returns**
3405
3406Returns a pointer to the [OH_UdmfData](#oh_udmfdata) instance created if the operation is successful; returns **nullptr** otherwise.
3407
3408**See**
3409
3410[OH_UdmfData](#oh_udmfdata)
3411
3412
3413### OH_UdmfData_Destroy()
3414
3415```
3416void OH_UdmfData_Destroy (OH_UdmfData* pThis)
3417```
3418
3419**Description**
3420
3421Destroys an [OH_UdmfData](#oh_udmfdata) instance.
3422
3423**Since**: 12
3424
3425**Parameters**
3426
3427| Name| Description|
3428| -------- | -------- |
3429| pThis | Pointer to the [OH_UdmfData](#oh_udmfdata) instance to destroy.|
3430
3431**See**
3432
3433[OH_UdmfData](#oh_udmfdata)
3434
3435
3436### OH_UdmfData_GetPrimaryHtml()
3437
3438```
3439int OH_UdmfData_GetPrimaryHtml (OH_UdmfData* data, OH_UdsHtml* html )
3440```
3441
3442**Description**
3443
3444Obtains the first [OH_UdsHtml](#oh_udshtml) data from an [OH_UdmfData](#oh_udmfdata) instance.
3445
3446**Since**: 13
3447
3448**Parameters**
3449
3450| Name| Description|
3451| -------- | -------- |
3452| data | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3453| html | Pointer to the [OH_UdsHtml](#oh_udshtml) data obtained.|
3454
3455**Returns**
3456
3457Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3458
3459**See**
3460
3461[OH_UdmfData](#oh_udmfdata)
3462
3463[OH_UdsHtml](#oh_udshtml)
3464
3465[Udmf_ErrCode](#udmf_errcode)
3466
3467
3468### OH_UdmfData_GetPrimaryPlainText()
3469
3470```
3471int OH_UdmfData_GetPrimaryPlainText (OH_UdmfData* data, OH_UdsPlainText* plainText )
3472```
3473
3474**Description**
3475
3476Obtains the first [OH_UdsPlainText](#oh_udsplaintext) data from an [OH_UdmfData](#oh_udmfdata) instance.
3477
3478**Since**: 13
3479
3480**Parameters**
3481
3482| Name| Description|
3483| -------- | -------- |
3484| data | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3485| plainText | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) data obtained.|
3486
3487**Returns**
3488
3489Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3490
3491**See**
3492
3493[OH_UdmfData](#oh_udmfdata)
3494
3495[OH_UdsPlainText](#oh_udsplaintext)
3496
3497[Udmf_ErrCode](#udmf_errcode)
3498
3499
3500### OH_UdmfData_GetRecord()
3501
3502```
3503OH_UdmfRecord* OH_UdmfData_GetRecord (OH_UdmfData* data, unsigned int index )
3504```
3505
3506**Description**
3507
3508Obtains the specified data record from an [OH_UdmfData](#oh_udmfdata) instance.
3509
3510**Since**: 13
3511
3512**Parameters**
3513
3514| Name| Description|
3515| -------- | -------- |
3516| data | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3517| index | Index of the [OH_UdmfRecord]( #oh_udmfrecord) in the OH_UdmfData]( #oh_udmfdata) instance.|
3518
3519**Returns**
3520
3521Returns a pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance obtained if the operation is successful; returns **nullptr** otherwise.
3522
3523**See**
3524
3525[OH_UdmfData](#oh_udmfdata)
3526
3527
3528### OH_UdmfData_GetRecordCount()
3529
3530```
3531int OH_UdmfData_GetRecordCount (OH_UdmfData* data)
3532```
3533
3534**Description**
3535
3536Obtains the number of data records contained in an [OH_UdmfData](#oh_udmfdata) instance.
3537
3538**Parameters**
3539
3540| Name| Description|
3541| -------- | -------- |
3542| data | Pointer to the target [OH_UdmfData](#oh_udmfdata) instance. |
3543
3544
3545### OH_UdmfData_GetRecords()
3546
3547```
3548OH_UdmfRecord** OH_UdmfData_GetRecords (OH_UdmfData* pThis, unsigned int* count )
3549```
3550
3551**Description**
3552
3553Obtains all records contained in an [OH_UdmfData](#oh_udmfdata) instance.
3554
3555**Since**: 12
3556
3557**Parameters**
3558
3559| Name| Description|
3560| -------- | -------- |
3561| pThis | Pointer to the target [OH_UdmfData](#oh_udmfdata) instance.|
3562| count | Pointer to the number of records obtained.|
3563
3564**Returns**
3565
3566Returns [OH_UdmfRecord](#oh_udmfrecord) obtained if the operation is successful; returns **nullptr** otherwise.
3567
3568**See**
3569
3570[OH_UdmfData](#oh_udmfdata)
3571
3572[OH_UdmfRecord](#oh_udmfrecord)
3573
3574
3575### OH_UdmfData_GetTypes()
3576
3577```
3578char** OH_UdmfData_GetTypes (OH_UdmfData* pThis, unsigned int* count )
3579```
3580
3581**Description**
3582
3583Obtains all data types in an [OH_UdmfData](#oh_udmfdata) instance.
3584
3585**Since**: 12
3586
3587**Parameters**
3588
3589| Name| Description|
3590| -------- | -------- |
3591| pThis | Pointer to the target [OH_UdmfData](#oh_udmfdata) instance.|
3592| count | Pointer to the number of data types obtained.|
3593
3594**Returns**
3595
3596Returns the data types obtained if the operation is successful; returns **nullptr** otherwise.
3597
3598**See**
3599
3600[OH_UdmfData](#oh_udmfdata)
3601
3602
3603### OH_UdmfData_HasType()
3604
3605```
3606bool OH_UdmfData_HasType (OH_UdmfData* pThis, const char* type )
3607```
3608
3609**Description**
3610
3611Checks whether the specified type exists in an [OH_UdmfData](#oh_udmfdata) instance.
3612
3613**Since**: 12
3614
3615**Parameters**
3616
3617| Name| Description|
3618| -------- | -------- |
3619| pThis | Pointer to the target [OH_UdmfData](#oh_udmfdata) instance.|
3620| type | Pointer to the type to check.|
3621
3622**Returns**
3623
3624Returns **true** if the data type exists; returns **false** otherwise.
3625
3626**See**
3627
3628[OH_UdmfData](#oh_udmfdata)
3629
3630
3631### OH_UdmfData_IsLocal()
3632
3633```
3634bool OH_UdmfData_IsLocal (OH_UdmfData* data)
3635```
3636
3637**Description**
3638
3639Checks whether an [OH_UdmfData](#oh_udmfdata) instance is from the local device.
3640
3641**Since**: 13
3642
3643**Parameters**
3644
3645| Name| Description|
3646| -------- | -------- |
3647| data | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3648
3649**Returns**
3650
3651Returns **true** if the data is from the local device; returns **false** otherwise.
3652
3653**See**
3654
3655[OH_UdmfData](#oh_udmfdata)
3656
3657
3658### OH_UdmfProperty_Create()
3659
3660```
3661OH_UdmfProperty* OH_UdmfProperty_Create (OH_UdmfData* unifiedData)
3662```
3663
3664**Description**
3665
3666Creates an [OH_UdmfProperty](#oh_udmfproperty) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfProperty_Destroy](#oh_udmfproperty_destroy) to destroy it. Otherwise, memory leaks may occur.
3667
3668**Since**: 12
3669
3670**Parameters**
3671
3672| Name| Description|
3673| -------- | -------- |
3674| unifiedData | Pointer to the [OH_UdmfData](#oh_udmfdata) instance.|
3675
3676**Returns**
3677
3678Returns a pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance created if the operation is successful; returns **nullptr** otherwise.
3679
3680**See**
3681
3682[OH_UdmfData](#oh_udmfdata)
3683
3684[OH_UdmfProperty](#oh_udmfproperty)
3685
3686
3687### OH_UdmfProperty_Destroy()
3688
3689```
3690void OH_UdmfProperty_Destroy (OH_UdmfProperty* pThis)
3691```
3692
3693**Description**
3694
3695Destroys an [OH_UdmfProperty](#oh_udmfproperty) instance.
3696
3697**Since**: 12
3698
3699**Parameters**
3700
3701| Name| Description|
3702| -------- | -------- |
3703| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance to destroy.|
3704
3705**See**
3706
3707[OH_UdmfProperty](#oh_udmfproperty)
3708
3709
3710### OH_UdmfProperty_GetExtrasIntParam()
3711
3712```
3713int OH_UdmfProperty_GetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int defaultValue )
3714```
3715
3716**Description**
3717
3718Obtains the customized extra integer parameter from an [OH_UdmfProperty](#oh_udmfproperty) instance.
3719
3720**Since**: 12
3721
3722**Parameters**
3723
3724| Name| Description|
3725| -------- | -------- |
3726| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3727| key | Pointer to the key of the parameter to obtain.|
3728| defaultValue | Default value to be returned if the parameter fails to be obtained.|
3729
3730**Returns**
3731
3732Returns the integer value obtained if the operation is successful; returns **defaultValue** if the operation fails.
3733
3734**See**
3735
3736[OH_UdmfProperty](#oh_udmfproperty)
3737
3738
3739### OH_UdmfProperty_GetExtrasStringParam()
3740
3741```
3742const char* OH_UdmfProperty_GetExtrasStringParam (OH_UdmfProperty* pThis, const char* key )
3743```
3744
3745**Description**
3746
3747Obtains the customized extra string parameter from an [OH_UdmfProperty](#oh_udmfproperty) instance.
3748
3749**Since**: 12
3750
3751**Parameters**
3752
3753| Name| Description|
3754| -------- | -------- |
3755| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3756| key | Pointer to the key of the parameter to obtain.|
3757
3758**Returns**
3759
3760Returns a pointer to the string value obtained if the operation is successful; returns **nullptr** otherwise.
3761
3762**See**
3763
3764[OH_UdmfProperty](#oh_udmfproperty)
3765
3766
3767### OH_UdmfProperty_GetShareOption()
3768
3769```
3770Udmf_ShareOption OH_UdmfProperty_GetShareOption (OH_UdmfProperty* pThis)
3771```
3772
3773**Description**
3774
3775Obtains the share option from an [OH_UdmfProperty](#oh_udmfproperty) instance.
3776
3777**Since**: 12
3778
3779**Parameters**
3780
3781| Name| Description|
3782| -------- | -------- |
3783| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3784
3785**Returns**
3786
3787Returns the [Udmf_ShareOption](#udmf_shareoption) obtained.
3788
3789**See**
3790
3791[OH_UdmfProperty](#oh_udmfproperty)
3792
3793[Udmf_ShareOption](#udmf_shareoption)
3794
3795
3796### OH_UdmfProperty_GetTag()
3797
3798```
3799const char* OH_UdmfProperty_GetTag (OH_UdmfProperty* pThis)
3800```
3801
3802**Description**
3803
3804Obtains the custom tag value from an [OH_UdmfProperty](#oh_udmfproperty) instance.
3805
3806**Since**: 12
3807
3808**Parameters**
3809
3810| Name| Description|
3811| -------- | -------- |
3812| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3813
3814**Returns**
3815
3816Returns a pointer to the custom tag value obtained if the operation is successful; returns **nullptr** otherwise.
3817
3818**See**
3819
3820[OH_UdmfProperty](#oh_udmfproperty)
3821
3822
3823### OH_UdmfProperty_GetTimestamp()
3824
3825```
3826int64_t OH_UdmfProperty_GetTimestamp (OH_UdmfProperty* pThis)
3827```
3828
3829**Description**
3830
3831Obtains the timestamp from an [OH_UdmfProperty](#oh_udmfproperty) instance.
3832
3833**Since**: 12
3834
3835**Parameters**
3836
3837| Name| Description|
3838| -------- | -------- |
3839| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3840
3841**Returns**
3842
3843Returns the timestamp obtained.
3844
3845**See**
3846
3847[OH_UdmfProperty](#oh_udmfproperty)
3848
3849
3850### OH_UdmfProperty_SetExtrasIntParam()
3851
3852```
3853int OH_UdmfProperty_SetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int param )
3854```
3855
3856**Description**
3857
3858Sets the extra integer parameter for an [OH_UdmfProperty](#oh_udmfproperty) instance.
3859
3860**Since**: 12
3861
3862**Parameters**
3863
3864| Name| Description|
3865| -------- | -------- |
3866| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
3867| key | Pointer to the key of the parameter to set.|
3868| param | Parameter value to set.|
3869
3870**Returns**
3871
3872Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3873
3874**See**
3875
3876[OH_UdmfProperty](#oh_udmfproperty)
3877
3878[Udmf_ErrCode](#udmf_errcode)
3879
3880
3881### OH_UdmfProperty_SetExtrasStringParam()
3882
3883```
3884int OH_UdmfProperty_SetExtrasStringParam (OH_UdmfProperty* pThis, const char* key, const char* param )
3885```
3886
3887**Description**
3888
3889Sets the extra string parameter for an [OH_UdmfProperty](#oh_udmfproperty) instance.
3890
3891**Since**: 12
3892
3893**Parameters**
3894
3895| Name| Description|
3896| -------- | -------- |
3897| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
3898| key | Pointer to the key of the parameter to set.|
3899| param | Parameter value to set.|
3900
3901**Returns**
3902
3903Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3904
3905**See**
3906
3907[OH_UdmfProperty](#oh_udmfproperty)
3908
3909[Udmf_ErrCode](#udmf_errcode)
3910
3911
3912### OH_UdmfProperty_SetShareOption()
3913
3914```
3915int OH_UdmfProperty_SetShareOption (OH_UdmfProperty* pThis, Udmf_ShareOption option )
3916```
3917
3918**Description**
3919
3920Sets the share option for an [OH_UdmfProperty](#oh_udmfproperty) instance.
3921
3922**Since**: 12
3923
3924**Parameters**
3925
3926| Name| Description|
3927| -------- | -------- |
3928| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3929| option | [Udmf_ShareOption](#udmf_shareoption) to set.|
3930
3931**Returns**
3932
3933Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3934
3935**See**
3936
3937[OH_UdmfProperty](#oh_udmfproperty)
3938
3939[Udmf_ShareOption](#udmf_shareoption)
3940
3941[Udmf_ErrCode](#udmf_errcode)
3942
3943
3944### OH_UdmfProperty_SetTag()
3945
3946```
3947int OH_UdmfProperty_SetTag (OH_UdmfProperty* pThis, const char* tag )
3948```
3949
3950**Description**
3951
3952Sets the tag value for an [OH_UdmfProperty](#oh_udmfproperty) instance.
3953
3954**Since**: 12
3955
3956**Parameters**
3957
3958| Name| Description|
3959| -------- | -------- |
3960| pThis | Pointer to the [OH_UdmfProperty](#oh_udmfproperty) instance.|
3961| tag | Pointer to the tag value to set.|
3962
3963**Returns**
3964
3965Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3966
3967**See**
3968
3969[OH_UdmfProperty](#oh_udmfproperty)
3970
3971[Udmf_ErrCode](#udmf_errcode)
3972
3973
3974### OH_UdmfRecord_AddAppItem()
3975
3976```
3977int OH_UdmfRecord_AddAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )
3978```
3979
3980**Description**
3981
3982Adds data of the [OH_UdsAppItem](#oh_udsappitem) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
3983
3984**Since**: 12
3985
3986**Parameters**
3987
3988| Name| Description|
3989| -------- | -------- |
3990| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
3991| appItem | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance to add.|
3992
3993**Returns**
3994
3995Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
3996
3997**See**
3998
3999[OH_UdmfRecord](#oh_udmfrecord)
4000
4001[OH_UdsAppItem](#oh_udsappitem)
4002
4003[Udmf_ErrCode](#udmf_errcode)
4004
4005
4006### OH_UdmfRecord_AddArrayBuffer()
4007
4008```
4009int OH_UdmfRecord_AddArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )
4010```
4011
4012**Description**
4013
4014Adds a data record of the [OH_UdsArrayBuffer](#oh_udsarraybuffer) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4015
4016**Since**: 13
4017
4018**Parameters**
4019
4020| Name| Description|
4021| -------- | -------- |
4022| record | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4023| type | Pointer to the ArrayBuffer type ID, which must be unique.|
4024| buffer | Pointer to the [OH_UdsArrayBuffer]( #oh_udsarraybuffer) instance.|
4025
4026**Returns**
4027
4028Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4029
4030**See**
4031
4032[OH_UdmfRecord](#oh_udmfrecord)
4033
4034[OH_UdsArrayBuffer](#oh_udsarraybuffer)
4035
4036[Udmf_ErrCode](#udmf_errcode)
4037
4038
4039### OH_UdmfRecord_AddFileUri()
4040
4041```
4042int OH_UdmfRecord_AddFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )
4043```
4044
4045**Description**
4046
4047Adds a data record of the [OH_UdsFileUri](#oh_udsfileuri) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4048
4049**Since**: 13
4050
4051**Parameters**
4052
4053| Name| Description|
4054| -------- | -------- |
4055| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4056| fileUri | Pointer to the [OH_UdsFileUri]( #oh_udsfileuri) instance.|
4057
4058**Returns**
4059
4060Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4061
4062**See**
4063
4064[OH_UdmfRecord](#oh_udmfrecord)
4065
4066[OH_UdsFileUri](#oh_udsfileuri)
4067
4068[Udmf_ErrCode](#udmf_errcode)
4069
4070
4071### OH_UdmfRecord_AddGeneralEntry()
4072
4073```
4074int OH_UdmfRecord_AddGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char* entry, unsigned int count )
4075```
4076
4077**Description**
4078
4079Adds customized uniform data to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4080
4081**Since**: 12
4082
4083**Parameters**
4084
4085| Name| Description|
4086| -------- | -------- |
4087| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4088| typeId | Pointer to the data type ID.|
4089| entry | Pointer to the customized data to add.|
4090| count | Size of customized data to add. The data size cannot exceed 4 KB.|
4091
4092**Returns**
4093
4094Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4095
4096**See**
4097
4098[OH_UdmfRecord](#oh_udmfrecord)
4099
4100[Udmf_ErrCode](#udmf_errcode)
4101
4102
4103### OH_UdmfRecord_AddHtml()
4104
4105```
4106int OH_UdmfRecord_AddHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )
4107```
4108
4109**Description**
4110
4111Adds data of the [OH_UdsHtml](#oh_udshtml) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4112
4113**Since**: 12
4114
4115**Parameters**
4116
4117| Name| Description|
4118| -------- | -------- |
4119| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4120| html | Pointer to the [OH_UdsHtml](#oh_udshtml) instance to add.|
4121
4122**Returns**
4123
4124Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4125
4126**See**
4127
4128[OH_UdmfRecord](#oh_udmfrecord)
4129
4130[OH_UdsHtml](#oh_udshtml)
4131
4132[Udmf_ErrCode](#udmf_errcode)
4133
4134
4135### OH_UdmfRecord_AddHyperlink()
4136
4137```
4138int OH_UdmfRecord_AddHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )
4139```
4140
4141**Description**
4142
4143Adds data of the hyperlink type [OH_UdsHyperlink](#oh_udshyperlink) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4144
4145**Since**: 12
4146
4147**Parameters**
4148
4149| Name| Description|
4150| -------- | -------- |
4151| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4152| hyperlink | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance to add.|
4153
4154**Returns**
4155
4156Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4157
4158**See**
4159
4160[OH_UdmfRecord](#oh_udmfrecord)
4161
4162[OH_UdsHyperlink](#oh_udshyperlink)
4163
4164[Udmf_ErrCode](#udmf_errcode)
4165
4166
4167### OH_UdmfRecord_AddPixelMap()
4168
4169```
4170int OH_UdmfRecord_AddPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )
4171```
4172
4173**Description**
4174
4175Adds a data record of the [OH_UdsPixelMap](#oh_udspixelmap) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4176
4177**Since**: 13
4178
4179**Parameters**
4180
4181| Name| Description|
4182| -------- | -------- |
4183| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4184| pixelMap | Pointer to the [OH_UdsPixelMap]( #oh_udspixelmap) instance.|
4185
4186**Returns**
4187
4188Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4189
4190**See**
4191
4192[OH_UdmfRecord](#oh_udmfrecord)
4193
4194[OH_UdsPixelMap](#oh_udspixelmap)
4195
4196[Udmf_ErrCode](#udmf_errcode)
4197
4198
4199### OH_UdmfRecord_AddPlainText()
4200
4201```
4202int OH_UdmfRecord_AddPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )
4203```
4204
4205**Description**
4206
4207Adds data of the [OH_UdsPlainText](#oh_udsplaintext) type to an [OH_UdmfRecord](#oh_udmfrecord) instance.
4208
4209**Since**: 12
4210
4211**Parameters**
4212
4213| Name| Description|
4214| -------- | -------- |
4215| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4216| plainText | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance to add.|
4217
4218**Returns**
4219
4220Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4221
4222**See**
4223
4224[OH_UdmfRecord](#oh_udmfrecord)
4225
4226[OH_UdsPlainText](#oh_udsplaintext)
4227
4228[Udmf_ErrCode](#udmf_errcode)
4229
4230
4231### OH_UdmfRecord_Create()
4232
4233```
4234OH_UdmfRecord* OH_UdmfRecord_Create ()
4235```
4236
4237**Description**
4238
4239Creates an [OH_UdmfRecord](#oh_udmfrecord) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfRecord_Destroy](#oh_udmfrecord_destroy) to destroy it. Otherwise, memory leaks may occur.
4240
4241**Since**: 12
4242
4243**Returns**
4244
4245Returns a pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance created if the operation is successful; returns **nullptr** otherwise.
4246
4247**See**
4248
4249[OH_UdmfRecord](#oh_udmfrecord)
4250
4251
4252### OH_UdmfRecord_Destroy()
4253
4254```
4255void OH_UdmfRecord_Destroy (OH_UdmfRecord* pThis)
4256```
4257
4258**Description**
4259
4260Destroys an [OH_UdmfRecord](#oh_udmfrecord) instance.
4261
4262**Since**: 12
4263
4264**Parameters**
4265
4266| Name| Description|
4267| -------- | -------- |
4268| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance to destroy.|
4269
4270**See**
4271
4272[OH_UdmfRecord](#oh_udmfrecord)
4273
4274
4275### OH_UdmfRecord_GetAppItem()
4276
4277```
4278int OH_UdmfRecord_GetAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )
4279```
4280
4281**Description**
4282
4283Obtains [OH_UdsAppItem](#oh_udsappitem) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4284
4285**Since**: 12
4286
4287**Parameters**
4288
4289| Name| Description|
4290| -------- | -------- |
4291| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4292| appItem | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance obtained.|
4293
4294**Returns**
4295
4296Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4297
4298**See**
4299
4300[OH_UdmfRecord](#oh_udmfrecord)
4301
4302[OH_UdsAppItem](#oh_udsappitem)
4303
4304[Udmf_ErrCode](#udmf_errcode)
4305
4306
4307### OH_UdmfRecord_GetArrayBuffer()
4308
4309```
4310int OH_UdmfRecord_GetArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )
4311```
4312
4313**Description**
4314
4315Obtains the [OH_UdsArrayBuffer](#oh_udsarraybuffer) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4316
4317**Since**: 13
4318
4319**Parameters**
4320
4321| Name| Description|
4322| -------- | -------- |
4323| record | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4324| type | Pointer to the data type ID of the ArrayBuffer data to obtain.|
4325| buffer | Pointer to the [OH_UdsArrayBuffer]( #oh_udsarraybuffer) data obtained.|
4326
4327**Returns**
4328
4329Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4330
4331**See**
4332
4333[OH_UdmfRecord](#oh_udmfrecord)
4334
4335[OH_UdsArrayBuffer](#oh_udsarraybuffer)
4336
4337[Udmf_ErrCode](#udmf_errcode)
4338
4339
4340### OH_UdmfRecord_GetFileUri()
4341
4342```
4343int OH_UdmfRecord_GetFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )
4344```
4345
4346**Description**
4347
4348Obtains the [OH_UdsFileUri](#oh_udsfileuri) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4349
4350**Since**: 13
4351
4352**Parameters**
4353
4354| Name| Description|
4355| -------- | -------- |
4356| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4357| fileUri | Pointer to the [OH_UdsFileUri]( #oh_udsfileuri) data obtained.|
4358
4359**Returns**
4360
4361Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4362
4363**See**
4364
4365[OH_UdmfRecord](#oh_udmfrecord)
4366
4367[OH_UdsFileUri](#oh_udsfileuri)
4368
4369[Udmf_ErrCode](#udmf_errcode)
4370
4371
4372### OH_UdmfRecord_GetGeneralEntry()
4373
4374```
4375int OH_UdmfRecord_GetGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char** entry, unsigned int* count )
4376```
4377
4378**Description**
4379
4380Obtains the data of the specified type in an [OH_UdmfRecord](#oh_udmfrecord) instance.
4381
4382**Since**: 12
4383
4384**Parameters**
4385
4386| Name| Description|
4387| -------- | -------- |
4388| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4389| typeId | Pointer to the data type ID.|
4390| entry | Double pointer to the data obtained.|
4391| count | Length of the data obtained.|
4392
4393**Returns**
4394
4395Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4396
4397**See**
4398
4399[OH_UdmfRecord](#oh_udmfrecord)
4400
4401[Udmf_ErrCode](#udmf_errcode)
4402
4403
4404### OH_UdmfRecord_GetHtml()
4405
4406```
4407int OH_UdmfRecord_GetHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )
4408```
4409
4410**Description**
4411
4412Obtains [OH_UdsHtml](#oh_udshtml) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4413
4414**Since**: 12
4415
4416**Parameters**
4417
4418| Name| Description|
4419| -------- | -------- |
4420| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4421| html | Pointer to the [OH_UdsHtml](#oh_udshtml) data obtained.|
4422
4423**Returns**
4424
4425Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4426
4427**See**
4428
4429[OH_UdmfRecord](#oh_udmfrecord)
4430
4431[OH_UdsHtml](#oh_udshtml)
4432
4433[Udmf_ErrCode](#udmf_errcode)
4434
4435
4436### OH_UdmfRecord_GetHyperlink()
4437
4438```
4439int OH_UdmfRecord_GetHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )
4440```
4441
4442**Description**
4443
4444Obtains [OH_UdsHyperlink](#oh_udshyperlink) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4445
4446**Since**: 12
4447
4448**Parameters**
4449
4450| Name| Description|
4451| -------- | -------- |
4452| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4453| hyperlink | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) data obtained.|
4454
4455**Returns**
4456
4457Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4458
4459**See**
4460
4461[OH_UdmfRecord](#oh_udmfrecord)
4462
4463[OH_UdsHyperlink](#oh_udshyperlink)
4464
4465[Udmf_ErrCode](#udmf_errcode)
4466
4467
4468### OH_UdmfRecord_GetPixelMap()
4469
4470```
4471int OH_UdmfRecord_GetPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )
4472```
4473
4474**Description**
4475
4476Obtains the [OH_UdsPixelMap](#oh_udspixelmap) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4477
4478**Since**: 13
4479
4480**Parameters**
4481
4482| Name| Description|
4483| -------- | -------- |
4484| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4485| pixelMap | Pointer to the [OH_UdsPixelMap]( #oh_udspixelmap) data obtained.|
4486
4487**Returns**
4488
4489Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4490
4491**See**
4492
4493[OH_UdmfRecord](#oh_udmfrecord)
4494
4495[OH_UdsPixelMap](#oh_udspixelmap)
4496
4497[Udmf_ErrCode](#udmf_errcode)
4498
4499
4500### OH_UdmfRecord_GetPlainText()
4501
4502```
4503int OH_UdmfRecord_GetPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )
4504```
4505
4506**Description**
4507
4508Obtains [OH_UdsPlainText](#oh_udsplaintext) data from an [OH_UdmfRecord](#oh_udmfrecord) instance.
4509
4510**Since**: 12
4511
4512**Parameters**
4513
4514| Name| Description|
4515| -------- | -------- |
4516| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4517| plainText | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) data obtained.|
4518
4519**Returns**
4520
4521Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4522
4523**See**
4524
4525[OH_UdmfRecord](#oh_udmfrecord)
4526
4527[OH_UdsPlainText](#oh_udsplaintext)
4528
4529[Udmf_ErrCode](#udmf_errcode)
4530
4531
4532### OH_UdmfRecord_GetTypes()
4533
4534```
4535char** OH_UdmfRecord_GetTypes (OH_UdmfRecord* pThis, unsigned int* count )
4536```
4537
4538**Description**
4539
4540Obtains all data types in an [OH_UdmfRecord](#oh_udmfrecord) instance.
4541
4542**Since**: 12
4543
4544**Parameters**
4545
4546| Name| Description|
4547| -------- | -------- |
4548| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4549| count | Pointer to the number of data types obtained.|
4550
4551**Returns**
4552
4553Returns a list of data types obtained if the operation is successful; returns **nullptr** otherwise.
4554
4555**See**
4556
4557[OH_UdmfRecord](#oh_udmfrecord)
4558
4559
4560### OH_UdmfRecord_SetProvider()
4561
4562```
4563int OH_UdmfRecord_SetProvider (OH_UdmfRecord* pThis, const char* const* types, unsigned int count, OH_UdmfRecordProvider* provider )
4564```
4565
4566**Description**
4567
4568Sets the [OH_UdmfRecordProvider](#oh_udmfrecordprovider) in an [OH_UdmfRecord](#oh_udmfrecord) instance.
4569
4570**Since**: 13
4571
4572**Parameters**
4573
4574| Name| Description|
4575| -------- | -------- |
4576| pThis | Pointer to the [OH_UdmfRecord](#oh_udmfrecord) instance.|
4577| types | Pointer to the data types to be provided.|
4578| count | Number of the data types.|
4579| provider | Pointer to the [OH_UdmfRecordProvider]( #oh_udmfrecordprovider) instance to set.|
4580
4581**Returns**
4582
4583Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4584
4585**See**
4586
4587[OH_UdmfRecord](#oh_udmfrecord)
4588
4589[OH_UdmfRecordProvider](#oh_udmfrecordprovider)
4590
4591[Udmf_ErrCode](#udmf_errcode)
4592
4593
4594### OH_UdmfRecordProvider_Create()
4595
4596```
4597OH_UdmfRecordProvider* OH_UdmfRecordProvider_Create ()
4598```
4599
4600**Description**
4601
4602Creates an [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance and a pointer to it. If this pointer is no longer required, use [OH_UdmfRecordProvider_Destroy](#oh_udmfrecordprovider_destroy) to destroy it. Otherwise, memory leaks may occur.
4603
4604**Since**: 13
4605
4606**Returns**
4607
4608Returns a pointer to the [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance created if the operation is successful; returns **nullptr** otherwise.
4609
4610**See**
4611
4612[OH_UdmfRecordProvider](#oh_udmfrecordprovider)
4613
4614
4615### OH_UdmfRecordProvider_Destroy()
4616
4617```
4618int OH_UdmfRecordProvider_Destroy (OH_UdmfRecordProvider* provider)
4619```
4620
4621**Description**
4622
4623Destroys an [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance.
4624
4625**Since**: 13
4626
4627**Parameters**
4628
4629| Name| Description|
4630| -------- | -------- |
4631| provider | Pointer to the [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance to destroy.|
4632
4633**Returns**
4634
4635Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4636
4637**See**
4638
4639[OH_UdmfRecordProvider](#oh_udmfrecordprovider)
4640
4641[Udmf_ErrCode](#udmf_errcode)
4642
4643
4644### OH_UdmfRecordProvider_SetData()
4645
4646```
4647int OH_UdmfRecordProvider_SetData (OH_UdmfRecordProvider* provider, void* context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize )
4648```
4649
4650**Description**
4651
4652Sets a callback for an **OH_UdmfRecordProvider** instance to provide data.
4653
4654**Since**: 13
4655
4656**Parameters**
4657
4658| Name| Description|
4659| -------- | -------- |
4660| provider | Pointer to the target [OH_UdmfRecordProvider](#oh_udmfrecordprovider) instance.|
4661| context | Pointer to the context, which is passed as the first parameter to [OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata).|
4662| callback | Callback used to obtain data. For details, see [OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata).|
4663| finalize | Optional callback used to release the context data when the **OH_UdmfRecordProvider** instance is destroyed. For details, see [UdmfData_Finalize](#udmfdata_finalize).|
4664
4665**Returns**
4666
4667Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4668
4669**See**
4670
4671[OH_UdmfRecordProvider](#oh_udmfrecordprovider)
4672
4673[OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata)
4674
4675[UdmfData_Finalize](#udmfdata_finalize) [Udmf_ErrCode](#udmf_errcode)
4676
4677
4678### OH_UdsAppItem_Create()
4679
4680```
4681OH_UdsAppItem* OH_UdsAppItem_Create ()
4682```
4683
4684**Description**
4685
4686Creates an [OH_UdsAppItem](#oh_udsappitem) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsAppItem_Destroy](#oh_udsappitem_destroy) to destroy it. Otherwise, memory leaks may occur.
4687
4688**Since**: 12
4689
4690**Returns**
4691
4692Returns a pointer to the [OH_UdsAppItem](#oh_udsappitem) data obtained; returns **nullptr** otherwise.
4693
4694**See**
4695
4696[OH_UdsAppItem](#oh_udsappitem)
4697
4698
4699### OH_UdsAppItem_Destroy()
4700
4701```
4702void OH_UdsAppItem_Destroy (OH_UdsAppItem* pThis)
4703```
4704
4705**Description**
4706
4707Destroys an [OH_UdsAppItem](#oh_udsappitem) instance.
4708
4709**Since**: 12
4710
4711**Parameters**
4712
4713| Name| Description|
4714| -------- | -------- |
4715| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance to destroy.|
4716
4717**See**
4718
4719[OH_UdsAppItem](#oh_udsappitem)
4720
4721
4722### OH_UdsAppItem_GetAbilityName()
4723
4724```
4725const char* OH_UdsAppItem_GetAbilityName (OH_UdsAppItem* pThis)
4726```
4727
4728**Description**
4729
4730Obtains the ability name from an [OH_UdsAppItem](#oh_udsappitem) instance.
4731
4732**Since**: 12
4733
4734**Parameters**
4735
4736| Name| Description|
4737| -------- | -------- |
4738| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4739
4740**Returns**
4741
4742Returns a pointer to the ability name obtained if the operation is successful; returns **nullptr** otherwise.
4743
4744**See**
4745
4746[OH_UdsAppItem](#oh_udsappitem)
4747
4748
4749### OH_UdsAppItem_GetBundleName()
4750
4751```
4752const char* OH_UdsAppItem_GetBundleName (OH_UdsAppItem* pThis)
4753```
4754
4755**Description**
4756
4757Obtains the bundle name from an [OH_UdsAppItem](#oh_udsappitem) instance.
4758
4759**Since**: 12
4760
4761**Parameters**
4762
4763| Name| Description|
4764| -------- | -------- |
4765| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4766
4767**Returns**
4768
4769Returns a pointer to the bundle name obtained if the operation is successful; returns **nullptr** otherwise.
4770
4771**See**
4772
4773[OH_UdsAppItem](#oh_udsappitem)
4774
4775
4776### OH_UdsAppItem_GetIconId()
4777
4778```
4779const char* OH_UdsAppItem_GetIconId (OH_UdsAppItem* pThis)
4780```
4781
4782**Description**
4783
4784Obtains the application icon ID from an [OH_UdsAppItem](#oh_udsappitem) instance.
4785
4786**Since**: 12
4787
4788**Parameters**
4789
4790| Name| Description|
4791| -------- | -------- |
4792| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4793
4794**Returns**
4795
4796Returns a pointer to the application icon ID obtained if the operation is successful; returns **nullptr** otherwise.
4797
4798**See**
4799
4800[OH_UdsAppItem](#oh_udsappitem)
4801
4802
4803### OH_UdsAppItem_GetId()
4804
4805```
4806const char* OH_UdsAppItem_GetId (OH_UdsAppItem* pThis)
4807```
4808
4809**Description**
4810
4811Obtains the application ID from an [OH_UdsAppItem](#oh_udsappitem) instance.
4812
4813**Since**: 12
4814
4815**Parameters**
4816
4817| Name| Description|
4818| -------- | -------- |
4819| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4820
4821**Returns**
4822
4823Returns a pointer to the application ID obtained if the operation is successful; returns **nullptr** otherwise.
4824
4825**See**
4826
4827[OH_UdsAppItem](#oh_udsappitem)
4828
4829
4830### OH_UdsAppItem_GetLabelId()
4831
4832```
4833const char* OH_UdsAppItem_GetLabelId (OH_UdsAppItem* pThis)
4834```
4835
4836**Description**
4837
4838Obtains the application label ID from an [OH_UdsAppItem](#oh_udsappitem) instance.
4839
4840**Since**: 12
4841
4842**Parameters**
4843
4844| Name| Description|
4845| -------- | -------- |
4846| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4847
4848**Returns**
4849
4850Returns a pointer to the application label ID obtained if the operation is successful; returns **nullptr** otherwise.
4851
4852**See**
4853
4854[OH_UdsAppItem](#oh_udsappitem)
4855
4856
4857### OH_UdsAppItem_GetName()
4858
4859```
4860const char* OH_UdsAppItem_GetName (OH_UdsAppItem* pThis)
4861```
4862
4863**Description**
4864
4865Obtains the application name from an [OH_UdsAppItem](#oh_udsappitem) instance.
4866
4867**Since**: 12
4868
4869**Parameters**
4870
4871| Name| Description|
4872| -------- | -------- |
4873| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4874
4875**Returns**
4876
4877Returns a pointer to the application name obtained if the operation is successful; returns **nullptr** otherwise.
4878
4879**See**
4880
4881[OH_UdsAppItem](#oh_udsappitem)
4882
4883
4884### OH_UdsAppItem_GetType()
4885
4886```
4887const char* OH_UdsAppItem_GetType (OH_UdsAppItem* pThis)
4888```
4889
4890**Description**
4891
4892Obtains the type ID from an [OH_UdsAppItem](#oh_udsappitem) instance.
4893
4894**Since**: 12
4895
4896**Parameters**
4897
4898| Name| Description|
4899| -------- | -------- |
4900| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4901
4902**Returns**
4903
4904Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
4905
4906**See**
4907
4908[OH_UdsAppItem](#oh_udsappitem)
4909
4910
4911### OH_UdsAppItem_SetAbilityName()
4912
4913```
4914int OH_UdsAppItem_SetAbilityName (OH_UdsAppItem* pThis, const char* abilityName )
4915```
4916
4917**Description**
4918
4919Sets the ability name for an [OH_UdsAppItem](#oh_udsappitem) instance.
4920
4921**Since**: 12
4922
4923**Parameters**
4924
4925| Name| Description|
4926| -------- | -------- |
4927| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4928| abilityName | Pointer to the ability name to set.|
4929
4930**Returns**
4931
4932Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4933
4934**See**
4935
4936[OH_UdsAppItem](#oh_udsappitem)
4937
4938
4939### OH_UdsAppItem_SetBundleName()
4940
4941```
4942int OH_UdsAppItem_SetBundleName (OH_UdsAppItem* pThis, const char* bundleName )
4943```
4944
4945**Description**
4946
4947Sets the bundle name for an [OH_UdsAppItem](#oh_udsappitem) instance.
4948
4949**Since**: 12
4950
4951**Parameters**
4952
4953| Name| Description|
4954| -------- | -------- |
4955| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4956| bundleName | Pointer to the bundle name to set.|
4957
4958**Returns**
4959
4960Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4961
4962**See**
4963
4964[OH_UdsAppItem](#oh_udsappitem)
4965
4966
4967### OH_UdsAppItem_SetIconId()
4968
4969```
4970int OH_UdsAppItem_SetIconId (OH_UdsAppItem* pThis, const char* appIconId )
4971```
4972
4973**Description**
4974
4975Sets the application icon ID for an [OH_UdsAppItem](#oh_udsappitem) instance.
4976
4977**Since**: 12
4978
4979**Parameters**
4980
4981| Name| Description|
4982| -------- | -------- |
4983| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
4984| appIconId | Pointer to the application icon ID to set.|
4985
4986**Returns**
4987
4988Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
4989
4990**See**
4991
4992[OH_UdsAppItem](#oh_udsappitem)
4993
4994
4995### OH_UdsAppItem_SetId()
4996
4997```
4998int OH_UdsAppItem_SetId (OH_UdsAppItem* pThis, const char* appId )
4999```
5000
5001**Description**
5002
5003Sets the application ID for an [OH_UdsAppItem](#oh_udsappitem) instance.
5004
5005**Since**: 12
5006
5007**Parameters**
5008
5009| Name| Description|
5010| -------- | -------- |
5011| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
5012| appId | Pointer to the application ID to set.|
5013
5014**Returns**
5015
5016Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5017
5018**See**
5019
5020[OH_UdsAppItem](#oh_udsappitem)
5021
5022
5023### OH_UdsAppItem_SetLabelId()
5024
5025```
5026int OH_UdsAppItem_SetLabelId (OH_UdsAppItem* pThis, const char* appLabelId )
5027```
5028
5029**Description**
5030
5031Sets the application label ID for an [OH_UdsAppItem](#oh_udsappitem) instance.
5032
5033**Since**: 12
5034
5035**Parameters**
5036
5037| Name| Description|
5038| -------- | -------- |
5039| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
5040| appLabelId | Pointer to the application label ID to set.|
5041
5042**Returns**
5043
5044Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5045
5046**See**
5047
5048[OH_UdsAppItem](#oh_udsappitem)
5049
5050
5051### OH_UdsAppItem_SetName()
5052
5053```
5054int OH_UdsAppItem_SetName (OH_UdsAppItem* pThis, const char* appName )
5055```
5056
5057**Description**
5058
5059Sets the application name for an [OH_UdsAppItem](#oh_udsappitem) instance.
5060
5061**Since**: 12
5062
5063**Parameters**
5064
5065| Name| Description|
5066| -------- | -------- |
5067| pThis | Pointer to the [OH_UdsAppItem](#oh_udsappitem) instance.|
5068| appName | Pointer to the application name to set.|
5069
5070**Returns**
5071
5072Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5073
5074**See**
5075
5076[OH_UdsAppItem](#oh_udsappitem)
5077
5078
5079### OH_UdsArrayBuffer_Create()
5080
5081```
5082OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create ()
5083```
5084
5085**Description**
5086
5087Creates an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsArrayBuffer_Destroy](#oh_udsarraybuffer_destroy) to destroy it. Otherwise, memory leaks may occur.
5088
5089**Since**: 13
5090
5091**Returns**
5092
5093Returns a pointer to the [OH_UdsArrayBuffer]( #oh_udsarraybuffer) instance created if the operation is successful; returns **nullptr** otherwise.
5094
5095**See**
5096
5097[OH_UdsArrayBuffer](#oh_udsarraybuffer)
5098
5099
5100### OH_UdsArrayBuffer_Destroy()
5101
5102```
5103int OH_UdsArrayBuffer_Destroy (OH_UdsArrayBuffer* buffer)
5104```
5105
5106**Description**
5107
5108Destroys an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.
5109
5110**Since**: 13
5111
5112**Parameters**
5113
5114| Name| Description|
5115| -------- | -------- |
5116| buffer | Pointer to the [OH_UdsArrayBuffer]( #oh_udsarraybuffer) instance.|
5117
5118**Returns**
5119
5120Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5121
5122**See**
5123
5124[OH_UdsArrayBuffer](#oh_udsarraybuffer)
5125
5126[Udmf_ErrCode](#udmf_errcode)
5127
5128
5129### OH_UdsArrayBuffer_GetData()
5130
5131```
5132int OH_UdsArrayBuffer_GetData (OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len )
5133```
5134
5135**Description**
5136
5137Obtains the custom ArrayBuffer data from an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.
5138
5139**Since**: 13
5140
5141**Parameters**
5142
5143| Name| Description|
5144| -------- | -------- |
5145| buffer | Pointer to the target [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.|
5146| data | Double pointer to the ArrayBuffer data obtained.|
5147| len | Pointer to the length of the ArrayBuffer data obtained.|
5148
5149**Returns**
5150
5151Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5152
5153**See**
5154
5155[OH_UdsArrayBuffer](#oh_udsarraybuffer)
5156
5157[Udmf_ErrCode](#udmf_errcode)
5158
5159
5160### OH_UdsArrayBuffer_SetData()
5161
5162```
5163int OH_UdsArrayBuffer_SetData (OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len )
5164```
5165
5166**Description**
5167
5168Sets an [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.
5169
5170**Since**: 13
5171
5172**Parameters**
5173
5174| Name| Description|
5175| -------- | -------- |
5176| buffer | Pointer to the target [OH_UdsArrayBuffer](#oh_udsarraybuffer) instance.|
5177| data | Pointer to the ArrayBuffer data to set.|
5178| len | Length of the ArrayBuffer data to set.|
5179
5180**Returns**
5181
5182Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5183
5184**See**
5185
5186[OH_UdsArrayBuffer](#oh_udsarraybuffer)
5187
5188[Udmf_ErrCode](#udmf_errcode)
5189
5190
5191### OH_UdsFileUri_Create()
5192
5193```
5194OH_UdsFileUri* OH_UdsFileUri_Create ()
5195```
5196
5197**Description**
5198
5199Creates an [OH_UdsFileUri](#oh_udsfileuri) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsFileUri_Destroy](#oh_udsfileuri_destroy) to destroy it. Otherwise, memory leaks may occur.
5200
5201**Since**: 13
5202
5203**Returns**
5204
5205Returns a pointer to the [OH_UdsFileUri](#oh_udsfileuri) instance created if the operation is successful; returns **nullptr** otherwise.
5206
5207**See**
5208
5209[OH_UdsFileUri](#oh_udsfileuri)
5210
5211
5212### OH_UdsFileUri_Destroy()
5213
5214```
5215void OH_UdsFileUri_Destroy (OH_UdsFileUri* pThis)
5216```
5217
5218**Description**
5219
5220Destroys an [OH_UdsFileUri](#oh_udsfileuri) instance.
5221
5222**Since**: 13
5223
5224**Parameters**
5225
5226| Name| Description|
5227| -------- | -------- |
5228| pThis | Pointer to the [OH_UdsFileUri]( #oh_udsfileuri) instance to destroy.|
5229
5230**See**
5231
5232[OH_UdsFileUri](#oh_udsfileuri)
5233
5234
5235### OH_UdsFileUri_GetFileType()
5236
5237```
5238const char* OH_UdsFileUri_GetFileType (OH_UdsFileUri* pThis)
5239```
5240
5241**Description**
5242
5243Obtains the file type from an [OH_UdsFileUri](#oh_udsfileuri) instance.
5244
5245**Since**: 13
5246
5247**Parameters**
5248
5249| Name| Description|
5250| -------- | -------- |
5251| pThis | Pointer to the target [OH_UdsFileUri]( #oh_udsfileuri) instance.|
5252
5253**Returns**
5254
5255Returns a pointer to the file type obtained if the operation is successful; returns **nullptr** otherwise.
5256
5257**See**
5258
5259[OH_UdsFileUri](#oh_udsfileuri)
5260
5261
5262### OH_UdsFileUri_GetFileUri()
5263
5264```
5265const char* OH_UdsFileUri_GetFileUri (OH_UdsFileUri* pThis)
5266```
5267
5268**Description**
5269
5270Obtains the file URI from an [OH_UdsFileUri](#oh_udsfileuri) instance.
5271
5272**Since**: 13
5273
5274**Parameters**
5275
5276| Name| Description|
5277| -------- | -------- |
5278| pThis | Pointer to the target [OH_UdsFileUri]( #oh_udsfileuri) instance.|
5279
5280**Returns**
5281
5282Returns a pointer to the file URI obtained if the operation is successful; returns **nullptr** otherwise.
5283
5284**See**
5285
5286[OH_UdsFileUri](#oh_udsfileuri)
5287
5288
5289### OH_UdsFileUri_GetType()
5290
5291```
5292const char* OH_UdsFileUri_GetType (OH_UdsFileUri* pThis)
5293```
5294
5295**Description**
5296
5297Obtains the type ID from an [OH_UdsFileUri](#oh_udsfileuri) instance.
5298
5299**Since**: 13
5300
5301**Parameters**
5302
5303| Name| Description|
5304| -------- | -------- |
5305| pThis | Pointer to the target [OH_UdsFileUri]( #oh_udsfileuri) instance.|
5306
5307**Returns**
5308
5309Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
5310
5311**See**
5312
5313[OH_UdsFileUri](#oh_udsfileuri)
5314
5315
5316### OH_UdsFileUri_SetFileType()
5317
5318```
5319int OH_UdsFileUri_SetFileType (OH_UdsFileUri* pThis, const char* fileType )
5320```
5321
5322**Description**
5323
5324Sets the file type for an [OH_UdsFileUri](#oh_udsfileuri) instance.
5325
5326**Since**: 13
5327
5328**Parameters**
5329
5330| Name| Description|
5331| -------- | -------- |
5332| pThis | Pointer to the target [OH_UdsFileUri]( #oh_udsfileuri) instance.|
5333| fileType | Pointer to the file type to set.|
5334
5335**Returns**
5336
5337Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5338
5339**See**
5340
5341[OH_UdsFileUri](#oh_udsfileuri)
5342
5343[Udmf_ErrCode](#udmf_errcode)
5344
5345
5346### OH_UdsFileUri_SetFileUri()
5347
5348```
5349int OH_UdsFileUri_SetFileUri (OH_UdsFileUri* pThis, const char* fileUri )
5350```
5351
5352**Description**
5353
5354Sets the URI information for an [OH_UdsFileUri](#oh_udsfileuri) instance.
5355
5356**Since**: 13
5357
5358**Parameters**
5359
5360| Name| Description|
5361| -------- | -------- |
5362| pThis | Pointer to the target [OH_UdsFileUri]( #oh_udsfileuri) instance.|
5363| fileUri | Pointer to the file URI to set.|
5364
5365**Returns**
5366
5367Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5368
5369**See**
5370
5371[OH_UdsFileUri](#oh_udsfileuri)
5372
5373[Udmf_ErrCode](#udmf_errcode)
5374
5375
5376### OH_UdsHtml_Create()
5377
5378```
5379OH_UdsHtml* OH_UdsHtml_Create ()
5380```
5381
5382**Description**
5383
5384Creates an [OH_UdsHtml](#oh_udshtml) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHtml_Destroy](#oh_udshtml_destroy) to destroy it. Otherwise, memory leaks may occur.
5385
5386**Since**: 12
5387
5388**Returns**
5389
5390Returns a pointer to the [OH_UdsHtml](#oh_udshtml) instance created if the operation is successful; returns **nullptr** otherwise.
5391
5392**See**
5393
5394[OH_UdsHtml](#oh_udshtml)
5395
5396
5397### OH_UdsHtml_Destroy()
5398
5399```
5400void OH_UdsHtml_Destroy (OH_UdsHtml* pThis)
5401```
5402
5403**Description**
5404
5405Destroys an [OH_UdsHtml](#oh_udshtml) instance.
5406
5407**Since**: 12
5408
5409**Parameters**
5410
5411| Name| Description|
5412| -------- | -------- |
5413| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance to destroy.|
5414
5415**See**
5416
5417[OH_UdsHtml](#oh_udshtml)
5418
5419
5420### OH_UdsHtml_GetContent()
5421
5422```
5423const char* OH_UdsHtml_GetContent (OH_UdsHtml* pThis)
5424```
5425
5426**Description**
5427
5428Obtains the HTML content from an [OH_UdsHtml](#oh_udshtml) instance.
5429
5430**Since**: 12
5431
5432**Parameters**
5433
5434| Name| Description|
5435| -------- | -------- |
5436| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance.|
5437
5438**Returns**
5439
5440Returns a pointer to the HTML content obtained if the operation is successful; returns **nullptr** otherwise.
5441
5442**See**
5443
5444[OH_UdsHtml](#oh_udshtml)
5445
5446
5447### OH_UdsHtml_GetPlainContent()
5448
5449```
5450const char* OH_UdsHtml_GetPlainContent (OH_UdsHtml* pThis)
5451```
5452
5453**Description**
5454
5455Obtains the plaintext from an [OH_UdsHtml](#oh_udshtml) instance.
5456
5457**Since**: 12
5458
5459**Parameters**
5460
5461| Name| Description|
5462| -------- | -------- |
5463| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance.|
5464
5465**Returns**
5466
5467Returns a pointer to the plaintext obtained if the operation is successful; returns **nullptr** otherwise.
5468
5469**See**
5470
5471[OH_UdsHtml](#oh_udshtml)
5472
5473
5474### OH_UdsHtml_GetType()
5475
5476```
5477const char* OH_UdsHtml_GetType (OH_UdsHtml* pThis)
5478```
5479
5480**Description**
5481
5482Obtains the type ID from an [OH_UdsHtml](#oh_udshtml) instance.
5483
5484**Since**: 12
5485
5486**Parameters**
5487
5488| Name| Description|
5489| -------- | -------- |
5490| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance.|
5491
5492**Returns**
5493
5494Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
5495
5496**See**
5497
5498[OH_UdsHtml](#oh_udshtml)
5499
5500
5501### OH_UdsHtml_SetContent()
5502
5503```
5504int OH_UdsHtml_SetContent (OH_UdsHtml* pThis, const char* content )
5505```
5506
5507**Description**
5508
5509Sets the HTML content for an [OH_UdsHtml](#oh_udshtml) instance.
5510
5511**Since**: 12
5512
5513**Parameters**
5514
5515| Name| Description|
5516| -------- | -------- |
5517| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance.|
5518| content | Pointer to the content in HTML format to set.|
5519
5520**Returns**
5521
5522Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5523
5524**See**
5525
5526[OH_UdsHtml](#oh_udshtml)
5527
5528
5529### OH_UdsHtml_SetPlainContent()
5530
5531```
5532int OH_UdsHtml_SetPlainContent (OH_UdsHtml* pThis, const char* plainContent )
5533```
5534
5535**Description**
5536
5537Sets the plaintext for an [OH_UdsHtml](#oh_udshtml) instance.
5538
5539**Since**: 12
5540
5541**Parameters**
5542
5543| Name| Description|
5544| -------- | -------- |
5545| pThis | Pointer to the [OH_UdsHtml](#oh_udshtml) instance.|
5546| plainContent | Pointer to the plain text content to set.|
5547
5548**Returns**
5549
5550Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5551
5552**See**
5553
5554[OH_UdsHtml](#oh_udshtml)
5555
5556
5557### OH_UdsHyperlink_Create()
5558
5559```
5560OH_UdsHyperlink* OH_UdsHyperlink_Create ()
5561```
5562
5563**Description**
5564
5565Creates an [OH_UdsHyperlink](#oh_udshyperlink) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHyperlink_Destroy](#oh_udshyperlink_destroy) to destroy it. Otherwise, memory leaks may occur.
5566
5567**Since**: 12
5568
5569**Returns**
5570
5571Returns a pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance created if the operation is successful; returns **nullptr** otherwise.
5572
5573**See**
5574
5575[OH_UdsHyperlink](#oh_udshyperlink)
5576
5577
5578### OH_UdsHyperlink_Destroy()
5579
5580```
5581void OH_UdsHyperlink_Destroy (OH_UdsHyperlink* pThis)
5582```
5583
5584**Description**
5585
5586Destroys an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5587
5588**Since**: 12
5589
5590**Parameters**
5591
5592| Name| Description|
5593| -------- | -------- |
5594| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance to destroy.|
5595
5596**See**
5597
5598[OH_UdsHyperlink](#oh_udshyperlink)
5599
5600
5601### OH_UdsHyperlink_GetDescription()
5602
5603```
5604const char* OH_UdsHyperlink_GetDescription (OH_UdsHyperlink* pThis)
5605```
5606
5607**Description**
5608
5609Obtains the description from an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5610
5611**Since**: 12
5612
5613**Parameters**
5614
5615| Name| Description|
5616| -------- | -------- |
5617| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance.|
5618
5619**Returns**
5620
5621Returns a pointer to the description obtained if the operation is successful; returns **nullptr** otherwise.
5622
5623**See**
5624
5625[OH_UdsHyperlink](#oh_udshyperlink)
5626
5627
5628### OH_UdsHyperlink_GetType()
5629
5630```
5631const char* OH_UdsHyperlink_GetType (OH_UdsHyperlink* pThis)
5632```
5633
5634**Description**
5635
5636Obtains the type ID from an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5637
5638**Since**: 12
5639
5640**Parameters**
5641
5642| Name| Description|
5643| -------- | -------- |
5644| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance.|
5645
5646**Returns**
5647
5648Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
5649
5650**See**
5651
5652[OH_UdsHyperlink](#oh_udshyperlink)
5653
5654
5655### OH_UdsHyperlink_GetUrl()
5656
5657```
5658const char* OH_UdsHyperlink_GetUrl (OH_UdsHyperlink* pThis)
5659```
5660
5661**Description**
5662
5663Obtains the URL from an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5664
5665**Since**: 12
5666
5667**Parameters**
5668
5669| Name| Description|
5670| -------- | -------- |
5671| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance.|
5672
5673**Returns**
5674
5675Returns a pointer to the URL obtained if the operation is successful; returns **nullptr** otherwise.
5676
5677**See**
5678
5679[OH_UdsHyperlink](#oh_udshyperlink)
5680
5681
5682### OH_UdsHyperlink_SetDescription()
5683
5684```
5685int OH_UdsHyperlink_SetDescription (OH_UdsHyperlink* pThis, const char* description )
5686```
5687
5688**Description**
5689
5690Sets the description for an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5691
5692**Since**: 12
5693
5694**Parameters**
5695
5696| Name| Description|
5697| -------- | -------- |
5698| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance.|
5699| description | Pointer to the description to set.|
5700
5701**Returns**
5702
5703Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5704
5705**See**
5706
5707[OH_UdsHyperlink](#oh_udshyperlink)
5708
5709
5710### OH_UdsHyperlink_SetUrl()
5711
5712```
5713int OH_UdsHyperlink_SetUrl (OH_UdsHyperlink* pThis, const char* url )
5714```
5715
5716**Description**
5717
5718Sets the URL for an [OH_UdsHyperlink](#oh_udshyperlink) instance.
5719
5720**Since**: 12
5721
5722**Parameters**
5723
5724| Name| Description|
5725| -------- | -------- |
5726| pThis | Pointer to the [OH_UdsHyperlink](#oh_udshyperlink) instance.|
5727| url | Pointer to the URL to set.|
5728
5729**Returns**
5730
5731Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5732
5733**See**
5734
5735[OH_UdsHyperlink](#oh_udshyperlink)
5736
5737
5738### OH_UdsPixelMap_Create()
5739
5740```
5741OH_UdsPixelMap* OH_UdsPixelMap_Create ()
5742```
5743
5744**Description**
5745
5746Creates an [OH_UdsPixelMap](#oh_udspixelmap) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPixelMap_Destroy](#oh_udspixelmap_destroy) to destroy it. Otherwise, memory leaks may occur.
5747
5748**Since**: 13
5749
5750**Returns**
5751
5752Returns a pointer to the [OH_UdsPixelMap](#oh_udspixelmap) instance created if the operation is successful; returns **nullptr** otherwise.
5753
5754**See**
5755
5756[OH_UdsPixelMap](#oh_udspixelmap)
5757
5758
5759### OH_UdsPixelMap_Destroy()
5760
5761```
5762void OH_UdsPixelMap_Destroy (OH_UdsPixelMap* pThis)
5763```
5764
5765**Description**
5766
5767Destroys an [OH_UdsPixelMap](#oh_udspixelmap) instance.
5768
5769**Since**: 13
5770
5771**Parameters**
5772
5773| Name| Description|
5774| -------- | -------- |
5775| pThis | Pointer to the [OH_UdsPixelMap]( #oh_udspixelmap) instance to destroy.|
5776
5777**See**
5778
5779[OH_UdsPixelMap](#oh_udspixelmap)
5780
5781
5782### OH_UdsPixelMap_GetPixelMap()
5783
5784```
5785void OH_UdsPixelMap_GetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )
5786```
5787
5788**Description**
5789
5790Obtains the pointer to the **OH_PixelmapNative** instance from an [OH_UdsPixelMap](#oh_udspixelmap) instance.
5791
5792**Since**: 13
5793
5794**Parameters**
5795
5796| Name| Description|
5797| -------- | -------- |
5798| pThis | Pointer to the target [OH_UdsPixelMap]( #oh_udspixelmap) instance.|
5799| pixelmapNative | Pointer to the **OH_PixelmapNative** instance obtained.|
5800
5801**See**
5802
5803[OH_UdsPixelMap](#oh_udspixelmap)
5804
5805OH_PixelmapNative
5806
5807
5808### OH_UdsPixelMap_GetType()
5809
5810```
5811const char* OH_UdsPixelMap_GetType (OH_UdsPixelMap* pThis)
5812```
5813
5814**Description**
5815
5816Obtains the type ID from an [OH_UdsPixelMap](#oh_udspixelmap) instance.
5817
5818**Since**: 13
5819
5820**Parameters**
5821
5822| Name| Description|
5823| -------- | -------- |
5824| pThis | Pointer to the target [OH_UdsPixelMap]( #oh_udspixelmap) instance.|
5825
5826**Returns**
5827
5828Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
5829
5830**See**
5831
5832[OH_UdsPixelMap](#oh_udspixelmap)
5833
5834
5835### OH_UdsPixelMap_SetPixelMap()
5836
5837```
5838int OH_UdsPixelMap_SetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )
5839```
5840
5841**Description**
5842
5843Sets the pixel map content for an [OH_UdsPixelMap](#oh_udspixelmap) instance.
5844
5845**Since**: 13
5846
5847**Parameters**
5848
5849| Name| Description|
5850| -------- | -------- |
5851| pThis | Pointer to the target [OH_UdsPixelMap]( #oh_udspixelmap) instance.|
5852| pixelmapNative | Pointer to the **OH_PixelmapNative** instance.|
5853
5854**Returns**
5855
5856Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
5857
5858**See**
5859
5860[OH_UdsPixelMap](#oh_udspixelmap)
5861
5862OH_PixelmapNative
5863
5864[Udmf_ErrCode](#udmf_errcode)
5865
5866
5867### OH_UdsPlainText_Create()
5868
5869```
5870OH_UdsPlainText* OH_UdsPlainText_Create ()
5871```
5872
5873**Description**
5874
5875Creates an [OH_UdsPlainText](#oh_udsplaintext) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPlainText_Destroy](#oh_udsplaintext_destroy) to destroy it. Otherwise, memory leaks may occur.
5876
5877**Since**: 12
5878
5879**Returns**
5880
5881Returns a pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance created if the operation is successful; returns **nullptr** otherwise.
5882
5883**See**
5884
5885[OH_UdsPlainText](#oh_udsplaintext)
5886
5887
5888### OH_UdsPlainText_Destroy()
5889
5890```
5891void OH_UdsPlainText_Destroy (OH_UdsPlainText* pThis)
5892```
5893
5894**Description**
5895
5896Destroys an [OH_UdsPlainText](#oh_udsplaintext) instance.
5897
5898**Since**: 12
5899
5900**Parameters**
5901
5902| Name| Description|
5903| -------- | -------- |
5904| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance to destroy.|
5905
5906**See**
5907
5908[OH_UdsPlainText](#oh_udsplaintext)
5909
5910
5911### OH_UdsPlainText_GetAbstract()
5912
5913```
5914const char* OH_UdsPlainText_GetAbstract (OH_UdsPlainText* pThis)
5915```
5916
5917**Description**
5918
5919Obtains the abstract from an [OH_UdsPlainText](#oh_udsplaintext) instance.
5920
5921**Since**: 12
5922
5923**Parameters**
5924
5925| Name| Description|
5926| -------- | -------- |
5927| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance.|
5928
5929**Returns**
5930
5931Returns a pointer to the abstract information obtained if the operation is successful; returns **nullptr** otherwise.
5932
5933**See**
5934
5935[OH_UdsPlainText](#oh_udsplaintext)
5936
5937
5938### OH_UdsPlainText_GetContent()
5939
5940```
5941const char* OH_UdsPlainText_GetContent (OH_UdsPlainText* pThis)
5942```
5943
5944**Description**
5945
5946Obtains the plaintext from an [OH_UdsPlainText](#oh_udsplaintext) instance.
5947
5948**Since**: 12
5949
5950**Parameters**
5951
5952| Name| Description|
5953| -------- | -------- |
5954| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance.|
5955
5956**Returns**
5957
5958Returns a pointer to the plaintext obtained if the operation is successful; returns **nullptr** otherwise.
5959
5960**See**
5961
5962[OH_UdsPlainText](#oh_udsplaintext)
5963
5964
5965### OH_UdsPlainText_GetType()
5966
5967```
5968const char* OH_UdsPlainText_GetType (OH_UdsPlainText* pThis)
5969```
5970
5971**Description**
5972
5973Obtains the type ID from an [OH_UdsPlainText](#oh_udsplaintext) instance.
5974
5975**Since**: 12
5976
5977**Parameters**
5978
5979| Name| Description|
5980| -------- | -------- |
5981| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance.|
5982
5983**Returns**
5984
5985Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
5986
5987**See**
5988
5989[OH_UdsPlainText](#oh_udsplaintext)
5990
5991
5992### OH_UdsPlainText_SetAbstract()
5993
5994```
5995int OH_UdsPlainText_SetAbstract (OH_UdsPlainText* pThis, const char* abstract )
5996```
5997
5998**Description**
5999
6000Sets the abstract for an [OH_UdsPlainText](#oh_udsplaintext) instance.
6001
6002**Since**: 12
6003
6004**Parameters**
6005
6006| Name| Description|
6007| -------- | -------- |
6008| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance.|
6009| abstract | Pointer to the abstract to set.|
6010
6011**Returns**
6012
6013Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
6014
6015**See**
6016
6017[OH_UdsPlainText](#oh_udsplaintext)
6018
6019
6020### OH_UdsPlainText_SetContent()
6021
6022```
6023int OH_UdsPlainText_SetContent (OH_UdsPlainText* pThis, const char* content )
6024```
6025
6026**Description**
6027
6028Sets the plaintext content for an [OH_UdsPlainText](#oh_udsplaintext) instance.
6029
6030**Since**: 12
6031
6032**Parameters**
6033
6034| Name| Description|
6035| -------- | -------- |
6036| pThis | Pointer to the [OH_UdsPlainText](#oh_udsplaintext) instance.|
6037| content | Pointer to the plaintext content to set.|
6038
6039**Returns**
6040
6041Returns a [Udmf_ErrCode](#udmf_errcode). <br>Returns **UDMF_E_OK** if the operation is successful. <br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.
6042
6043**See**
6044
6045[OH_UdsPlainText](#oh_udsplaintext)
6046
6047
6048### OH_Utd_BelongsTo()
6049
6050```
6051bool OH_Utd_BelongsTo (const char* srcTypeId, const char* destTypeId )
6052```
6053
6054**Description**
6055
6056Checks whether a UTD belongs to the target UTD.
6057
6058**Since**: 12
6059
6060**Parameters**
6061
6062| Name| Description|
6063| -------- | -------- |
6064| srcTypeId | Pointer to the UTD to check. |
6065| destTypeId | Pointer to the target UTD.|
6066
6067**Returns**
6068
6069Returns **true** if the UTD belongs to the target UTD; returns **false** otherwise.
6070
6071
6072### OH_Utd_Create()
6073
6074```
6075OH_Utd* OH_Utd_Create (const char* typeId)
6076```
6077
6078**Description**
6079
6080Creates an [OH_Utd](#oh_utd) instance and a pointer to it.
6081
6082**Since**: 12
6083
6084**Parameters**
6085
6086| Name| Description|
6087| -------- | -------- |
6088| typeId | Pointer to the type ID of the instance to create.|
6089
6090**Returns**
6091
6092Returns a pointer to the [OH_Utd](#oh_utd) instance created if the operation is successful; returns **nullptr** otherwise. If this pointer is no longer required, use [OH_Utd_Destroy](#oh_utd_destroy) to destroy it. Otherwise, memory leaks may occur.
6093
6094**See**
6095
6096[OH_Utd](#oh_utd)
6097
6098
6099### OH_Utd_Destroy()
6100
6101```
6102void OH_Utd_Destroy (OH_Utd* pThis)
6103```
6104
6105**Description**
6106
6107Destroys an [OH_Utd](#oh_utd) instance.
6108
6109**Since**: 12
6110
6111**Parameters**
6112
6113| Name| Description|
6114| -------- | -------- |
6115| pThis | Pointer to the [OH_Utd](#oh_utd) instance to destroy.|
6116
6117**See**
6118
6119[OH_Utd](#oh_utd)
6120
6121
6122### OH_Utd_DestroyStringList()
6123
6124```
6125void OH_Utd_DestroyStringList (const char** list, unsigned int count )
6126```
6127
6128**Description**
6129
6130Destroys a UTD list.
6131
6132**Since**: 12
6133
6134**Parameters**
6135
6136| Name| Description|
6137| -------- | -------- |
6138| list | Double pointer to the UTD list to destroy.|
6139| count | Length of the UTD list.|
6140
6141
6142### OH_Utd_Equals()
6143
6144```
6145bool OH_Utd_Equals (OH_Utd* utd1, OH_Utd* utd2 )
6146```
6147
6148**Description**
6149
6150Checks whether two UTDs are the same.
6151
6152**Since**: 12
6153
6154**Parameters**
6155
6156| Name| Description|
6157| -------- | -------- |
6158| desc1 | Pointer to one [OH_Utd](#oh_utd) instance to compare.|
6159| desc2 | Pointer to the other [OH_Utd](#oh_utd) instance to compare.|
6160
6161**Returns**
6162
6163Returns **true** if the two instances are the same; returns **false** otherwise.
6164
6165
6166### OH_Utd_GetBelongingToTypes()
6167
6168```
6169const char** OH_Utd_GetBelongingToTypes (OH_Utd* pThis, unsigned int* count )
6170```
6171
6172**Description**
6173
6174Obtains the relationships between the data in an [OH_Utd](#oh_utd) instance.
6175
6176**Since**: 12
6177
6178**Parameters**
6179
6180| Name| Description|
6181| -------- | -------- |
6182| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6183| count | Pointer to the number of data types obtained.|
6184
6185**Returns**
6186
6187Returns a pointer to the relationship information obtained if the operation is successful; returns **nullptr** otherwise.
6188
6189**See**
6190
6191[OH_Utd](#oh_utd)
6192
6193
6194### OH_Utd_GetDescription()
6195
6196```
6197const char* OH_Utd_GetDescription (OH_Utd* pThis)
6198```
6199
6200**Description**
6201
6202Obtains the description from an [OH_Utd](#oh_utd) instance.
6203
6204**Since**: 12
6205
6206**Parameters**
6207
6208| Name| Description|
6209| -------- | -------- |
6210| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6211
6212**Returns**
6213
6214Returns a pointer to the description obtained if the operation is successful; returns **nullptr** otherwise.
6215
6216**See**
6217
6218[OH_Utd](#oh_utd)
6219
6220
6221### OH_Utd_GetFilenameExtensions()
6222
6223```
6224const char** OH_Utd_GetFilenameExtensions (OH_Utd* pThis, unsigned int* count )
6225```
6226
6227**Description**
6228
6229Obtains the file name extensions associated with an [OH_Utd](#oh_utd) instance.
6230
6231**Since**: 12
6232
6233**Parameters**
6234
6235| Name| Description|
6236| -------- | -------- |
6237| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6238| count | Pointer to the number of file name extensions obtained.|
6239
6240**Returns**
6241
6242Returns a pointer to the file name extensions obtained if the operation is successful; returns **nullptr** otherwise.
6243
6244**See**
6245
6246[OH_Utd](#oh_utd)
6247
6248
6249### OH_Utd_GetIconFile()
6250
6251```
6252const char* OH_Utd_GetIconFile (OH_Utd* pThis)
6253```
6254
6255**Description**
6256
6257Obtains the path of the default icon file from an [OH_Utd](#oh_utd) instance.
6258
6259**Since**: 12
6260
6261**Parameters**
6262
6263| Name| Description|
6264| -------- | -------- |
6265| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6266
6267**Returns**
6268
6269Returns a pointer to the path of the default icon file obtained if the operation is successful; returns **nullptr** otherwise.
6270
6271**See**
6272
6273[OH_Utd](#oh_utd)
6274
6275
6276### OH_Utd_GetMimeTypes()
6277
6278```
6279const char** OH_Utd_GetMimeTypes (OH_Utd* pThis, unsigned int* count )
6280```
6281
6282**Description**
6283
6284Obtains the MIME types associated with an [OH_Utd](#oh_utd) instance.
6285
6286**Since**: 12
6287
6288**Parameters**
6289
6290| Name| Description|
6291| -------- | -------- |
6292| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6293| count | Pointer to the number of MIME types obtained.|
6294
6295**Returns**
6296
6297Returns a pointer to the MIME types obtained if the operation is successful; returns **nullptr** otherwise.
6298
6299**See**
6300
6301[OH_Utd](#oh_utd)
6302
6303
6304### OH_Utd_GetReferenceUrl()
6305
6306```
6307const char* OH_Utd_GetReferenceUrl (OH_Utd* pThis)
6308```
6309
6310**Description**
6311
6312Obtains the URL from an [OH_Utd](#oh_utd) instance.
6313
6314**Since**: 12
6315
6316**Parameters**
6317
6318| Name| Description|
6319| -------- | -------- |
6320| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6321
6322**Returns**
6323
6324Returns a pointer to the URL obtained if the operation is successful; returns **nullptr** otherwise.
6325
6326**See**
6327
6328[OH_Utd](#oh_utd)
6329
6330
6331### OH_Utd_GetTypeId()
6332
6333```
6334const char* OH_Utd_GetTypeId (OH_Utd* pThis)
6335```
6336
6337**Description**
6338
6339Obtains the type ID from an [OH_Utd](#oh_utd) instance.
6340
6341**Since**: 12
6342
6343**Parameters**
6344
6345| Name| Description|
6346| -------- | -------- |
6347| pThis | Pointer to the [OH_Utd](#oh_utd) instance.|
6348
6349**Returns**
6350
6351Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.
6352
6353**See**
6354
6355[OH_Utd](#oh_utd)
6356
6357
6358### OH_Utd_GetTypesByFilenameExtension()
6359
6360```
6361const char** OH_Utd_GetTypesByFilenameExtension (const char* extension, unsigned int* count )
6362```
6363
6364**Description**
6365
6366Obtains the uniform data types based on the file name extensions.
6367
6368**Since**: 12
6369
6370**Parameters**
6371
6372| Name| Description|
6373| -------- | -------- |
6374| extension | Pointer to the file name extensions.|
6375| count | Pointer to the number of data types obtained.|
6376
6377**Returns**
6378
6379Returns a pointer to the uniform data types obtained. If it is no longer required, use [OH_Utd_DestroyStringList](#oh_utd_destroystringlist) to destroy it. Otherwise, memory leakage occurs.
6380
6381
6382### OH_Utd_GetTypesByMimeType()
6383
6384```
6385const char** OH_Utd_GetTypesByMimeType (const char* mimeType, unsigned int* count )
6386```
6387
6388**Description**
6389
6390Obtains the uniform data types based on the MIME types.
6391
6392**Since**: 12
6393
6394**Parameters**
6395
6396| Name| Description|
6397| -------- | -------- |
6398| mimeType | Pointer to the MIME types.|
6399| count | Pointer to the number of data types obtained.|
6400
6401**Returns**
6402
6403Returns a pointer to the uniform data types obtained. If it is no longer required, use [OH_Utd_DestroyStringList](#oh_utd_destroystringlist) to destroy it. Otherwise, memory leakage occurs.
6404
6405
6406### OH_Utd_IsHigher()
6407
6408```
6409bool OH_Utd_IsHigher (const char* srcTypeId, const char* destTypeId )
6410```
6411
6412**Description**
6413
6414Checks whether a UTD is a higher-level type of the target UTD. For example, **SOURCE_CODE** is a higher-level type of **TYPE_SCRIPT**, and **PLAIN_TEXT** is a higher-level type of **SOURCE_CODE** and **TYPE_SCRIPT**.
6415
6416**Since**: 12
6417
6418**Parameters**
6419
6420| Name| Description|
6421| -------- | -------- |
6422| srcTypeId | Pointer to the UTD to check. |
6423| destTypeId | Pointer to the target UTD.|
6424
6425**Returns**
6426
6427Returns **true** if the UTD is a higher-level type of the target UTD; returns **false** otherwise.
6428
6429
6430### OH_Utd_IsLower()
6431
6432```
6433bool OH_Utd_IsLower (const char* srcTypeId, const char* destTypeId )
6434```
6435
6436**Description**
6437
6438Checks whether a UTD is a lower-level type of the target UTD. For example, **TYPE_SCRIPT** is a lower-level type of **SOURCE_CODE**, and **TYPE_SCRIPT** and **SOURCE_CODE** are lower-level types of **PLAIN_TEXT**.
6439
6440**Since**: 12
6441
6442**Parameters**
6443
6444| Name| Description|
6445| -------- | -------- |
6446| srcTypeId | Pointer to the UTD to check. |
6447| destTypeId | Pointer to the target UTD.|
6448
6449**Returns**
6450
6451Returns **true** if the UTD is a lower-level type of the target UTD; returns **false** otherwise.
6452