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