UDMF
Overview
The 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.
Since: 12
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Summary
Files
| Name | Description |
|---|---|
| udmf.h | Defines the APIs, data structs, and enums for accessing the UDMF. File to include: <database/udmf/udmf.h> |
| udmf_err_code.h | Declares the error codes used in the UDMF. File to include: <database/udmf/udmf_err_code.h> |
| udmf_meta.h | Declares the uniform data types. File to include: <database/udmf/udmf_meta.h> |
| uds.h | Defines the APIs and structs related to the uniform data structs. File to include: <database/udmf/uds.h> |
| utd.h | Defines APIs and structs related to the Uniform Type Descriptors (UTDs). File to include: <database/udmf/utd.h> |
Macros
| Name | Description |
|---|---|
| UDMF_KEY_BUFFER_LEN (512) | Minimum length of the buffer that holds the key (unique identifier) of a uniform data object. |
| UDMF_META_ENTITY "general.entity" | Generic type that represents all physical storage types. It is used to define physical properties of a type. This type is uncategorized. |
| UDMF_META_OBJECT "general.object" | Generic type that represents all logical content types. It is used to define physical properties of a type. This type is uncategorized. |
| UDMF_META_COMPOSITE_OBJECT "general.composite-object" | Generic composite content type. For example, a PDF file that contains text and image. This type belongs to OBJECT. |
| UDMF_META_TEXT "general.text" | Generic text type. This type belongs to OBJECT. |
| UDMF_META_PLAIN_TEXT "general.plain-text" | Text without specific encoding or identifier. This type belongs to TEXT. |
| UDMF_META_HTML "general.html" | HTML. This type belongs to TEXT. |
| UDMF_META_HYPERLINK "general.hyperlink" | Hyperlink. This type belongs to TEXT. |
| UDMF_META_XML "general.xml" | XML. This type belongs to TEXT. |
| UDMF_META_SOURCE_CODE "general.source-code" | Generic source code type. This type belongs to PLAIN_TEXT. |
| UDMF_META_SCRIPT "general.script" | Source code in any scripting language. This type belongs to SOURCE_CODE. |
| UDMF_META_SHELL_SCRIPT "general.shell-script" | Shell script. This type belongs to SCRIPT. |
| UDMF_META_CSH_SCRIPT "general.csh-script" | C shell script. This type belongs to SHELL_SCRIPT. |
| UDMF_META_PERL_SCRIPT "general.perl-script" | Perl script. This type belongs to SHELL_SCRIPT. |
| UDMF_META_PHP_SCRIPT "general.php-script" | PHP script. This type belongs to SHELL_SCRIPT. |
| UDMF_META_PYTHON_SCRIPT "general.python-script" | Python script. This type belongs to SHELL_SCRIPT. |
| UDMF_META_RUBY_SCRIPT "general.ruby-script" | Ruby script. This type belongs to SHELL_SCRIPT. |
| UDMF_META_TYPE_SCRIPT "general.type-script" | TypeScript source code. This type belongs to SCRIPT. |
| UDMF_META_JAVA_SCRIPT "general.java-script" | JavaScript source code. This type belongs to SCRIPT. |
| UDMF_META_C_HEADER "general.c-header" | Header file in C. This type belongs to SOURCE_CODE. |
| UDMF_META_C_SOURCE "general.c-source" | Source code in C. This type belongs to SOURCE_CODE. |
| UDMF_META_C_PLUS_PLUS_HEADER "general.c-plus-plus-header" | Header file in C++. This type belongs to SOURCE_CODE. |
| UDMF_META_C_PLUS_PLUS_SOURCE "general.c-plus-plus-source" | Source code in C++. This type belongs to SOURCE_CODE. |
| UDMF_META_JAVA_SOURCE "general.java-source" | Source code in Java. This type belongs to SOURCE_CODE. |
| UDMF_META_EBOOK "general.ebook" | Generic eBook file format type. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_EPUB "general.epub" | Electronic publication (EPUB). This type belongs to EBOOK. |
| UDMF_META_AZW "com.amazon.azw" | AZW. This type belongs to EBOOK. |
| UDMF_META_AZW3 "com.amazon.azw3" | AZW3. This type belongs to EBOOK. |
| UDMF_META_KFX "com.amazon.kfx" | KFX. This type belongs to EBOOK. |
| UDMF_META_MOBI "com.amazon.mobi" | MOBI. This type belongs to EBOOK. |
| UDMF_META_MEDIA "general.media" | Generic media type. This type belongs to OBJECT. |
| UDMF_META_IMAGE "general.image" | Image. This type belongs to MEDIA. |
| UDMF_META_JPEG "general.jpeg" | JPEG. This type belongs to IMAGE. |
| UDMF_META_PNG "general.png" | PNG. This type belongs to IMAGE. |
| UDMF_META_RAW_IMAGE "general.raw-image" | Raw image. This type belongs to IMAGE. |
| UDMF_META_TIFF "general.tiff" | TIFF. This type belongs to IMAGE. |
| UDMF_META_BMP "com.microsoft.bmp" | BMP. This type belongs to IMAGE. |
| UDMF_META_ICO "com.microsoft.ico" | Windows icon. This type belongs to IMAGE. |
| UDMF_META_PHOTOSHOP_IMAGE "com.adobe.photoshop-image" | Adobe Photoshop image. This type belongs to IMAGE. |
| UDMF_META_AI_IMAGE "com.adobe.illustrator.ai-image" | Adobe Illustrator image (.ai). This type belongs to IMAGE. |
| UDMF_META_WORD_DOC "com.microsoft.word.doc" | Microsoft Word. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_EXCEL "com.microsoft.excel.xls" | Microsoft Excel. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_PPT "com.microsoft.powerpoint.ppt" | Microsoft PowerPoint presentation format. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_PDF "com.adobe.pdf" | PDF. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_POSTSCRIPT "com.adobe.postscript" | PostScript. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_ENCAPSULATED_POSTSCRIPT "com.adobe.encapsulated-postscript" | Encapsulated PostScript. This type belongs to POSTSCRIPT. |
| UDMF_META_VIDEO "general.video" | Generic video type. This type belongs to MEDIA. |
| UDMF_META_AVI "general.avi" | AVI. This type belongs to VIDEO. |
| UDMF_META_MPEG "general.mpeg" | MPGE-1 or MPGE-2. This type belongs to VIDEO. |
| UDMF_META_MPEG4 "general.mpeg-4" | MPGE-4. This type belongs to VIDEO. |
| UDMF_META_VIDEO_3GPP "general.3gpp" | 3GP (3GPP file format). This type belongs to VIDEO. |
| UDMF_META_VIDEO_3GPP2 "general.3gpp2" | 3G2 (3GPP2 file format). This type belongs to VIDEO. |
| UDMF_META_WINDOWS_MEDIA_WM "com.microsoft.windows-media-wm" | Windows WM format. This type belongs to VIDEO. |
| UDMF_META_WINDOWS_MEDIA_WMV "com.microsoft.windows-media-wmv" | Windows WMV format. This type belongs to VIDEO. |
| UDMF_META_WINDOWS_MEDIA_WMP "com.microsoft.windows-media-wmp" | Windows WMP format. This type belongs to VIDEO. |
| UDMF_META_AUDIO "general.audio" | Generic audio type. This type belongs to MEDIA. |
| UDMF_META_AAC "general.aac" | AAC. This type belongs to AUDIO. |
| UDMF_META_AIFF "general.aiff" | AIFF. This type belongs to AUDIO. |
| UDMF_META_ALAC "general.alac" | ALAC. This type belongs to AUDIO. |
| UDMF_META_FLAC "general.flac" | FLAC. This type belongs to AUDIO. |
| UDMF_META_MP3 "general.mp3" | MP3. This type belongs to AUDIO. |
| UDMF_META_OGG "general.ogg" | OGG. This type belongs to AUDIO. |
| UDMF_META_PCM "general.pcm" | PCM. This type belongs to AUDIO. |
| UDMF_META_WINDOWS_MEDIA_WMA "com.microsoft.windows-media-wma" | Windows WMA. This type belongs to AUDIO. |
| UDMF_META_WAVEFORM_AUDIO "com.microsoft.waveform-audio" | Windows Waveform. This type belongs to AUDIO. |
| UDMF_META_WINDOWS_MEDIA_WMX "com.microsoft.windows-media-wmx" | Windows WMX format. This type belongs to VIDEO. |
| UDMF_META_WINDOWS_MEDIA_WVX "com.microsoft.windows-media-wvx" | Windows WVX format. This type belongs to VIDEO. |
| UDMF_META_WINDOWS_MEDIA_WAX "com.microsoft.windows-media-wax" | Windows WAX. This type belongs to AUDIO. |
| UDMF_META_GENERAL_FILE "general.file" | Generic file type. This type belongs to ENTITY. |
| UDMF_META_DIRECTORY "general.directory" | Generic directory type. This type belongs to ENTITY. |
| UDMF_META_FOLDER "general.folder" | Generic folder type. This type belongs to DIRECTORY. |
| UDMF_META_SYMLINK "general.symlink" | Generic symbolic type. This type belongs to ENTITY. |
| UDMF_META_ARCHIVE "general.archive" | Generic archive file type. This type belongs to OBJECT. |
| UDMF_META_BZ2_ARCHIVE "general.bz2-archive" | BZ2. This type belongs to ARCHIVE. |
| UDMF_META_DISK_IMAGE "general.disk-image" | Generic type of any file that can be mounted as a volume. This type belongs to ARCHIVE. |
| UDMF_META_TAR_ARCHIVE "general.tar-archive" | TAR. This type belongs to ARCHIVE. |
| UDMF_META_ZIP_ARCHIVE "general.zip-archive" | ZIP. This type belongs to ARCHIVE. |
| UDMF_META_JAVA_ARCHIVE "com.sun.java-archive" | JAR (Java archive). This type belongs to ARCHIVE and EXECUTABLE. |
| UDMF_META_GNU_TAR_ARCHIVE "org.gnu.gnu-tar-archive" | GUN archive. This type belongs to ARCHIVE. |
| UDMF_META_GNU_ZIP_ARCHIVE "org.gnu.gnu-zip-archive" | GZIP archive. This type belongs to ARCHIVE. |
| UDMF_META_GNU_ZIP_TAR_ARCHIVE "org.gnu.gnu-zip-tar-archive" | GZIP TAR. This type belongs to ARCHIVE. |
| UDMF_META_CALENDAR "general.calendar" | Generic calendar type. This type belongs to OBJECT. |
| UDMF_META_CONTACT "general.contact" | Generic contact type. This type belongs to OBJECT. |
| UDMF_META_DATABASE "general.database" | Generic database file type. This type belongs to OBJECT. |
| UDMF_META_MESSAGE "general.message" | Generic message type. This type belongs to OBJECT. |
| UDMF_META_VCARD "general.vcard" | Generic electronic business card type. This type belongs to OBJECT. |
| UDMF_META_NAVIGATION "general.navigation" | Generic navigation data type. This type belongs to OBJECT. |
| UDMF_META_LOCATION "general.location" | Location data. This type belongs to NAVIGATION. |
| UDMF_META_OPENHARMONY_FORM "openharmony.form" | Widget defined for the system. This type belongs to OBJECT. |
| UDMF_META_OPENHARMONY_APP_ITEM "openharmony.app-item" | Home screen icon defined for the system. This type belongs to OBJECT. |
| UDMF_META_OPENHARMONY_PIXEL_MAP "openharmony.pixel-map" | Pixel map defined for the system. This type belongs to IMAGE. |
| UDMF_META_OPENHARMONY_ATOMIC_SERVICE "openharmony.atomic-service" | Atomic service type defined for the system. This type belongs to OBJECT. |
| UDMF_META_OPENHARMONY_PACKAGE "openharmony.package" | Package (compressed folder) defined for the system. This type belongs to DIRECTORY. |
| UDMF_META_OPENHARMONY_HAP "openharmony.hap" | Ability package defined for the system. This type belongs to OPENHARMONY_PACKAGE. |
| UDMF_META_SMIL "com.real.smil" | Synchronized Multimedia Integration Language (SMIL). This type belongs to XML. |
| UDMF_META_MARKDOWN "general.markdown" | Markdown. This type belongs to PLAIN_TEXT. |
| UDMF_META_FAX "general.fax" | Generic type of the fax. This type belongs to IMAGE. |
| UDMF_META_JFX_FAX "com.j2.jfx-fax" | J2 jConnect fax file format. This type belongs to FAX. |
| UDMF_META_EFX_FAX "com.js.efx-fax" | EFX file format. This type belongs to FAX. |
| UDMF_META_XBITMAP_IMAGE "general.xbitmap-image" | X BitMAP (XBM) used in the X Window system (X11). This type belongs to IMAGE. |
| UDMF_META_TGA_IMAGE "com.truevision.tga-image" | Tagged Graphics (TGA) format. This type belongs to IMAGE. |
| UDMF_META_SGI_IMAGE "com.sgi.sgi-image" | Silicon Graphics image (SGI) format. This type belongs to IMAGE. |
| UDMF_META_OPENEXR_IMAGE "com.ilm.openexr-image" | OpenXR image format. This type belongs to IMAGE. |
| UDMF_META_FLASHPIX_IMAGE "com.kodak.flashpix.image" | FlashPix image format. This type belongs to IMAGE. |
| UDMF_META_REALMEDIA "com.real.realmedia" | RealMedia format. This type belongs to VIDEO. |
| UDMF_META_AU_AUDIO "general.au-audio" | AU format. This type belongs to AUDIO. |
| UDMF_META_AIFC_AUDIO "general.aifc-audio" | AIFC. This type belongs to AUDIO. |
| UDMF_META_SD2_AUDIO "com.digidesign.sd2-audio" | Digidesign Sound Designer II (SDII). This type belongs to AUDIO. |
| UDMF_META_REALAUDIO "com.real.realaudio" | RealAudio. This type belongs to AUDIO. |
| UDMF_META_OPENXML "org.openxmlformats.openxml" | OpenXML base type. This type belongs to ARCHIVE. |
| UDMF_META_WORDPROCESSINGML_DOCUMENT "org.openxmlformats.wordprocessingml.document" | WordProcessingML format. This type belongs to OPENXML and COMPOSITE_OBJECT. |
| UDMF_META_SPREADSHEETML_SHEET "org.openxmlformats.spreadsheetml.sheet" | SpreadsheetML format. This type belongs to OPENXML and COMPOSITE_OBJECT. |
| UDMF_META_PRESENTATIONML_PRESENTATION "org.openxmlformats.presentationml.presentation" | PresentationML format. This type belongs to OPENXML and COMPOSITE_OBJECT. |
| UDMF_META_OPENDOCUMENT "org.oasis.opendocument" | OpenDocument format for Office applications. This type belongs to ARCHIVE. |
| UDMF_META_OPENDOCUMENT_TEXT "org.oasis.opendocument.text" | OpenDocument format for word processing (text) documents. This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT. |
| UDMF_META_OPENDOCUMENT_SPREADSHEET "org.oasis.opendocument.spreadsheet" | OpenDocument format for spreadsheets. This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT. |
| UDMF_META_OPENDOCUMENT_PRESENTATION "org.oasis.opendocument.presentation" | OpenDocument format for presentations. This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT. |
| UDMF_META_OPENDOCUMENT_GRAPHICS "org.oasis.opendocument.graphics" | OpenDocument format for graphics. This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT. |
| UDMF_META_OPENDOCUMENT_FORMULA "org.oasis.opendocument.formula" | OpenDocument format for formula. This type belongs to OPENDOCUMENT. |
| UDMF_META_STUFFIT_ARCHIVE "com.allume.stuffit-archive" | Stuffit compression format (stuffit archive). This type belongs to ARCHIVE. |
| UDMF_META_VCS "general.vcs" | VCalendar (VCS) format. This type belongs to CALENDAR and TEXT. |
| UDMF_META_ICS "general.ics" | Internet Calendaring and Scheduling (ICS) format. This type belongs to CALENDAR and TEXT. |
| UDMF_META_EXECUTABLE "general.executable" | Generic type of all executable files. This type belongs to OBJECT. |
| UDMF_META_PORTABLE_EXECUTABLE "com.microsoft.portable-executable" | Microsoft Windows portable executable format. This type belongs to EXECUTABLE. |
| UDMF_META_SUN_JAVA_CLASS "com.sun.java-class" | Java class file format. This type belongs to EXECUTABLE. |
| UDMF_META_FONT "general.font" | Basic type of fonts. This type belongs to OBJECT. |
| UDMF_META_TRUETYPE_FONT "general.truetype-font" | TrueType font format. This type belongs to FONT. |
| UDMF_META_TRUETYPE_COLLECTION_FONT "general.truetype-collection-font" | TrueType Collection font format. This type belongs to FONT. |
| UDMF_META_OPENTYPE_FONT "general.opentype-font" | OpenType font format. This type belongs to FONT. |
| UDMF_META_POSTSCRIPT_FONT "com.adobe.postscript-font" | PostScript font format. This type belongs to FONT. |
| UDMF_META_POSTSCRIPT_PFB_FONT "com.adobe.postscript-pfb-font" | PostScript Font Binary font format. This type belongs to FONT. |
| UDMF_META_POSTSCRIPT_PFA_FONT "com.adobe.postscript-pfa-font" | Adobe Type 1 font format. This type belongs to FONT. |
| UDMF_META_OPENHARMONY_HDOC "openharmony.hdoc" | Memo format defined for the system. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_OPENHARMONY_HINOTE "openharmony.hinote" | Note format defined for the system. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_OPENHARMONY_STYLED_STRING "openharmony.styled-string" | Style string type defined for the system. This type belongs to COMPOSITE_OBJECT. |
| UDMF_META_OPENHARMONY_WANT "openharmony.want" | Want defined for the system. This type belongs to OBJECT. |
| UDMF_META_GENERAL_FILE_URI "general.file-uri" | File address type. This type belongs to TEXT. |
| UDMF_METE_GENERAL_CONTENT_FORM "general.content-form" | Content widget type. This type belongs to OBJECT. |
Types
| Name | Description |
|---|---|
| typedef enum Udmf_Intention Udmf_Intention | Defines an enum for UDMF data channels. |
| typedef enum Udmf_ShareOption Udmf_ShareOption | Defines an enum for the scopes of the uniform data to be used on a device. |
| typedef struct OH_UdmfData OH_UdmfData | Defines a struct for a uniform data object. |
| typedef struct OH_UdmfRecord OH_UdmfRecord | Defines a struct for a data record in a uniform data object. |
| typedef struct OH_UdmfRecordProvider OH_UdmfRecordProvider | Defines a struct for the data record provider in a uniform data object. |
| typedef struct OH_UdmfProperty OH_UdmfProperty | Defines a struct for a data record property in a uniform data object. |
| typedef void(* UdmfData_Finalize) (void *context) | Defines a callback function used to release the context. This callback is invoked when the OH_UdmfRecordProvider instance is destroyed. |
| typedef void *(* 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. |
| typedef enum Udmf_ErrCode Udmf_ErrCode | Defines an enum for error codes. |
| typedef struct OH_UdsPlainText OH_UdsPlainText | Defines a struct for the uniform data of the plain text type. |
| typedef struct OH_UdsHyperlink OH_UdsHyperlink | Defines a struct for the uniform data of the hyperlink type. |
| typedef struct OH_UdsHtml OH_UdsHtml | Defines a struct for the uniform data of the Hypertext Markup Language (HTML) type. |
| typedef struct OH_UdsAppItem OH_UdsAppItem | Defines a struct for the uniform data of the home screen icon type. |
| typedef struct OH_UdsFileUri OH_UdsFileUri | Defines a struct for the file URI type. |
| typedef struct OH_UdsPixelMap OH_UdsPixelMap | Defines a struct for the pixel map type. |
| typedef struct OH_UdsArrayBuffer OH_UdsArrayBuffer | Defines a struct for the ArrayBuffer type. |
| typedef struct OH_Utd OH_Utd | Defines a struct for a Uniform Type Descriptor (UTD). |
| typedef struct OH_UdsContentForm OH_UdsContentForm | Defines a struct for the uniform data of the content widget type. |
Enums
| Name | Description |
|---|---|
| Udmf_Intention { UDMF_INTENTION_DRAG, UDMF_INTENTION_PASTEBOARD } | Enumerates the UDMF data channel types. |
| Udmf_ShareOption { SHARE_OPTIONS_INVALID, SHARE_OPTIONS_IN_APP, SHARE_OPTIONS_CROSS_APP } | Enumerates the scopes of the uniform data to be used on a device. |
| Udmf_ErrCode { UDMF_E_OK = 0, UDMF_ERR = 20400000, UDMF_E_INVALID_PARAM = (UDMF_ERR + 1) } | Enumerates the error codes. |
Functions
| Name | Description |
|---|---|
| int OH_UdmfRecord_AddContentForm (OH_UdmfRecord *pThis, OH_UdsContentForm *contentForm) | Adds data of the OH_UdsContentForm type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetContentForm (OH_UdmfRecord *pThis, OH_UdsContentForm *contentForm) | Obtains data of the OH_UdsContentForm type from an OH_UdmfRecord instance. |
| OH_UdsContentForm * OH_UdsContentForm_Create () | Creates an OH_UdsContentForm instance and a pointer to it. |
| void OH_UdsContentForm_Destroy (OH_UdsContentForm *pThis) | Destroys an OH_UdsContentForm instance. |
| const char * OH_UdsContentForm_GetType (OH_UdsContentForm *pThis) | Obtains the type ID from an OH_UdsContentForm instance. |
| int OH_UdsContentForm_GetThumbData (OH_UdsContentForm *pThis, unsigned char **thumbData, unsigned int *len) | Obtains image data from an OH_UdsContentForm instance. |
| const char * OH_UdsContentForm_GetDescription (OH_UdsContentForm *pThis) | Obtains the description from an OH_UdsContentForm instance. |
| const char * OH_UdsContentForm_GetTitle (OH_UdsContentForm *pThis) | Obtains the title from an OH_UdsContentForm instance. |
| int OH_UdsContentForm_GetAppIcon (OH_UdsContentForm *pThis, unsigned char **appIcon, unsigned int *len) | Obtains the application icon data from an OH_UdsContentForm instance. |
| const char * OH_UdsContentForm_GetAppName (OH_UdsContentForm *pThis) | Obtains the application name from an OH_UdsContentForm instance. |
| const char * OH_UdsContentForm_GetLinkUri (OH_UdsContentForm *pThis) | Obtains the hyperlink information from an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetThumbData (OH_UdsContentForm *pThis, const unsigned char *thumbData, unsigned int len) | Sets the image data for an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetDescription (OH_UdsContentForm *pThis, const char *description) | Sets the description for an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetTitle (OH_UdsContentForm *pThis, const char *title) | Sets the title for an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetAppIcon (OH_UdsContentForm *pThis, const unsigned char *appIcon, unsigned int len) | Sets the application icon data for an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetAppName (OH_UdsContentForm *pThis, const char *appName) | Sets the application name for an OH_UdsContentForm instance. |
| int OH_UdsContentForm_SetLinkUri (OH_UdsContentForm *pThis, const char *linkUri) | Sets the hyperlink data for an OH_UdsContentForm instance. |
| OH_UdmfData * OH_UdmfData_Create () | Creates an OH_UdmfData instance and a pointer to it. If this pointer is no longer required, use OH_UdmfData_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdmfData_Destroy (OH_UdmfData *pThis) | Destroys an OH_UdmfData instance. |
| int OH_UdmfData_AddRecord (OH_UdmfData *pThis, OH_UdmfRecord *record) | Adds an OH_UdmfRecord to an OH_UdmfData instance. |
| bool OH_UdmfData_HasType (OH_UdmfData *pThis, const char *type) | Checks whether the specified type exists in an OH_UdmfData instance. |
| char ** OH_UdmfData_GetTypes (OH_UdmfData *pThis, unsigned int *count) | Obtains all data types in an OH_UdmfData instance. |
| OH_UdmfRecord ** OH_UdmfData_GetRecords (OH_UdmfData *pThis, unsigned int *count) | Obtains all records contained in an OH_UdmfData instance. |
| OH_UdmfRecordProvider * OH_UdmfRecordProvider_Create () | Creates an OH_UdmfRecordProvider instance and a pointer to it. If this pointer is no longer required, use OH_UdmfRecordProvider_Destroy to destroy it. Otherwise, memory leaks may occur. |
| int OH_UdmfRecordProvider_Destroy (OH_UdmfRecordProvider *provider) | Destroys an OH_UdmfRecordProvider instance. |
| int OH_UdmfRecordProvider_SetData (OH_UdmfRecordProvider *provider, void *context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize) | Sets a callback for an OH_UdmfRecordProvider instance to provide data. |
| OH_UdmfRecord * OH_UdmfRecord_Create () | Creates an OH_UdmfRecord instance and a pointer to it. If this pointer is no longer required, use OH_UdmfRecord_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdmfRecord_Destroy (OH_UdmfRecord *pThis) | Destroys an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddGeneralEntry (OH_UdmfRecord *pThis, const char *typeId, unsigned char *entry, unsigned int count) | Adds customized uniform data to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddPlainText (OH_UdmfRecord *pThis, OH_UdsPlainText *plainText) | Adds data of the OH_UdsPlainText type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddHyperlink (OH_UdmfRecord *pThis, OH_UdsHyperlink *hyperlink) | Adds data of the hyperlink type OH_UdsHyperlink type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddHtml (OH_UdmfRecord *pThis, OH_UdsHtml *html) | Adds data of the OH_UdsHtml type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddAppItem (OH_UdmfRecord *pThis, OH_UdsAppItem *appItem) | Adds data of the OH_UdsAppItem type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddFileUri (OH_UdmfRecord *pThis, OH_UdsFileUri *fileUri) | Adds a data record of the OH_UdsFileUri type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddPixelMap (OH_UdmfRecord *pThis, OH_UdsPixelMap *pixelMap) | Adds a data record of the OH_UdsPixelMap type to an OH_UdmfRecord instance. |
| int OH_UdmfRecord_AddArrayBuffer (OH_UdmfRecord *record, const char *type, OH_UdsArrayBuffer *buffer) | Adds a data record of the OH_UdsArrayBuffer type to an OH_UdmfRecord instance. |
| char ** OH_UdmfRecord_GetTypes (OH_UdmfRecord *pThis, unsigned int *count) | Obtains all data types in an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetGeneralEntry (OH_UdmfRecord *pThis, const char *typeId, unsigned char **entry, unsigned int *count) | Obtains the data of the specified type in an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetPlainText (OH_UdmfRecord *pThis, OH_UdsPlainText *plainText) | Obtains OH_UdsPlainText data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetHyperlink (OH_UdmfRecord *pThis, OH_UdsHyperlink *hyperlink) | Obtains OH_UdsHyperlink data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetHtml (OH_UdmfRecord *pThis, OH_UdsHtml *html) | Obtains OH_UdsHtml data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetAppItem (OH_UdmfRecord *pThis, OH_UdsAppItem *appItem) | Obtains OH_UdsAppItem data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_SetProvider (OH_UdmfRecord *pThis, const char *const *types, unsigned int count, OH_UdmfRecordProvider *provider) | Sets the OH_UdmfRecordProvider in an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetFileUri (OH_UdmfRecord *pThis, OH_UdsFileUri *fileUri) | Obtains the OH_UdsFileUri data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetPixelMap (OH_UdmfRecord *pThis, OH_UdsPixelMap *pixelMap) | Obtains the OH_UdsPixelMap data from an OH_UdmfRecord instance. |
| int OH_UdmfRecord_GetArrayBuffer (OH_UdmfRecord *record, const char *type, OH_UdsArrayBuffer *buffer) | Obtains the OH_UdsArrayBuffer data from an OH_UdmfRecord instance. |
| int OH_UdmfData_GetPrimaryPlainText (OH_UdmfData *data, OH_UdsPlainText *plainText) | Obtains the first OH_UdsPlainText data from an OH_UdmfData instance. |
| int OH_UdmfData_GetPrimaryHtml (OH_UdmfData *data, OH_UdsHtml *html) | Obtains the first OH_UdsHtml data from an OH_UdmfData instance. |
| int OH_UdmfData_GetRecordCount (OH_UdmfData *data) | Obtains the number of data records contained in an OH_UdmfData instance. |
| OH_UdmfRecord * OH_UdmfData_GetRecord (OH_UdmfData *data, unsigned int index) | Obtains the specified data record from an OH_UdmfData instance. |
| bool OH_UdmfData_IsLocal (OH_UdmfData *data) | Checks whether an OH_UdmfData instance is from the local device. |
| OH_UdmfProperty * OH_UdmfProperty_Create (OH_UdmfData *unifiedData) | Creates an OH_UdmfProperty instance and a pointer to it. If this pointer is no longer required, use OH_UdmfProperty_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdmfProperty_Destroy (OH_UdmfProperty *pThis) | Destroys an OH_UdmfProperty instance. |
| const char * OH_UdmfProperty_GetTag (OH_UdmfProperty *pThis) | Obtains the custom tag value from an OH_UdmfProperty instance. |
| int64_t OH_UdmfProperty_GetTimestamp (OH_UdmfProperty *pThis) | Obtains the timestamp from an OH_UdmfProperty instance. |
| Udmf_ShareOption OH_UdmfProperty_GetShareOption (OH_UdmfProperty *pThis) | Obtains the share option from an OH_UdmfProperty instance. |
| int OH_UdmfProperty_GetExtrasIntParam (OH_UdmfProperty *pThis, const char *key, int defaultValue) | Obtains the customized extra integer parameter from an OH_UdmfProperty instance. |
| const char * OH_UdmfProperty_GetExtrasStringParam (OH_UdmfProperty *pThis, const char *key) | Obtains the customized extra string parameter from an OH_UdmfProperty instance. |
| int OH_UdmfProperty_SetTag (OH_UdmfProperty *pThis, const char *tag) | Sets the tag value for an OH_UdmfProperty instance. |
| int OH_UdmfProperty_SetShareOption (OH_UdmfProperty *pThis, Udmf_ShareOption option) | Sets the share option for an OH_UdmfProperty instance. |
| int OH_UdmfProperty_SetExtrasIntParam (OH_UdmfProperty *pThis, const char *key, int param) | Sets the extra integer parameter for an OH_UdmfProperty instance. |
| int OH_UdmfProperty_SetExtrasStringParam (OH_UdmfProperty *pThis, const char *key, const char *param) | Sets the extra string parameter for an OH_UdmfProperty instance. |
| int OH_Udmf_GetUnifiedData (const char *key, Udmf_Intention intention, OH_UdmfData *unifiedData) | Obtains an OH_UdmfData instance from the UDMF database. |
| int OH_Udmf_SetUnifiedData (Udmf_Intention intention, OH_UdmfData *unifiedData, char *key, unsigned int keyLen) | Sets an OH_UdmfData instance in the UDMF database. |
| OH_UdsPlainText * OH_UdsPlainText_Create () | Creates an OH_UdsPlainText instance and a pointer to it. If this pointer is no longer required, use OH_UdsPlainText_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsPlainText_Destroy (OH_UdsPlainText *pThis) | Destroys an OH_UdsPlainText instance. |
| const char * OH_UdsPlainText_GetType (OH_UdsPlainText *pThis) | Obtains the type ID from an OH_UdsPlainText instance. |
| const char * OH_UdsPlainText_GetContent (OH_UdsPlainText *pThis) | Obtains the plaintext from an OH_UdsPlainText instance. |
| const char * OH_UdsPlainText_GetAbstract (OH_UdsPlainText *pThis) | Obtains the abstract from an OH_UdsPlainText instance. |
| int OH_UdsPlainText_SetContent (OH_UdsPlainText *pThis, const char *content) | Sets the plaintext for an OH_UdsPlainText instance. |
| int OH_UdsPlainText_SetAbstract (OH_UdsPlainText *pThis, const char *abstract) | Sets the abstract for an OH_UdsPlainText instance. |
| OH_UdsHyperlink * OH_UdsHyperlink_Create () | Creates an OH_UdsHyperlink instance and a pointer to it. If this pointer is no longer required, use OH_UdsHyperlink_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsHyperlink_Destroy (OH_UdsHyperlink *pThis) | Destroys an OH_UdsHyperlink instance. |
| const char * OH_UdsHyperlink_GetType (OH_UdsHyperlink *pThis) | Obtains the type ID from an OH_UdsHyperlink instance. |
| const char * OH_UdsHyperlink_GetUrl (OH_UdsHyperlink *pThis) | Obtains the URL from an OH_UdsHyperlink instance. |
| const char * OH_UdsHyperlink_GetDescription (OH_UdsHyperlink *pThis) | Obtains the description from an OH_UdsHyperlink instance. |
| int OH_UdsHyperlink_SetUrl (OH_UdsHyperlink *pThis, const char *url) | Sets the URL for an OH_UdsHyperlink instance. |
| int OH_UdsHyperlink_SetDescription (OH_UdsHyperlink *pThis, const char *description) | Sets the description for an OH_UdsHyperlink instance. |
| OH_UdsHtml * OH_UdsHtml_Create () | Creates an OH_UdsHtml instance and a pointer to it. If this pointer is no longer required, use OH_UdsHtml_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsHtml_Destroy (OH_UdsHtml *pThis) | Destroys an OH_UdsHtml instance. |
| const char * OH_UdsHtml_GetType (OH_UdsHtml *pThis) | Obtains the type ID from an OH_UdsHtml instance. |
| const char * OH_UdsHtml_GetContent (OH_UdsHtml *pThis) | Obtains the HTML content from an OH_UdsHtml instance. |
| const char * OH_UdsHtml_GetPlainContent (OH_UdsHtml *pThis) | Obtains the plaintext from an OH_UdsHtml instance. |
| int OH_UdsHtml_SetContent (OH_UdsHtml *pThis, const char *content) | Sets the HTML content for an OH_UdsHtml instance. |
| int OH_UdsHtml_SetPlainContent (OH_UdsHtml *pThis, const char *plainContent) | Sets the plaintext for an OH_UdsHtml instance. |
| OH_UdsAppItem * OH_UdsAppItem_Create () | Creates an OH_UdsAppItem instance and a pointer to it. If this pointer is no longer required, use OH_UdsAppItem_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsAppItem_Destroy (OH_UdsAppItem *pThis) | Destroys an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetType (OH_UdsAppItem *pThis) | Obtains the type ID from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetId (OH_UdsAppItem *pThis) | Obtains the application ID from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetName (OH_UdsAppItem *pThis) | Obtains the application name from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetIconId (OH_UdsAppItem *pThis) | Obtains the application icon ID from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetLabelId (OH_UdsAppItem *pThis) | Obtains the application label ID from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetBundleName (OH_UdsAppItem *pThis) | Obtains the bundle name from an OH_UdsAppItem instance. |
| const char * OH_UdsAppItem_GetAbilityName (OH_UdsAppItem *pThis) | Obtains the ability name from an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetId (OH_UdsAppItem *pThis, const char *appId) | Sets the application ID for an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetName (OH_UdsAppItem *pThis, const char *appName) | Sets the application name for an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetIconId (OH_UdsAppItem *pThis, const char *appIconId) | Sets the application icon ID for an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetLabelId (OH_UdsAppItem *pThis, const char *appLabelId) | Sets the application label ID for an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetBundleName (OH_UdsAppItem *pThis, const char *bundleName) | Sets the bundle name for an OH_UdsAppItem instance. |
| int OH_UdsAppItem_SetAbilityName (OH_UdsAppItem *pThis, const char *abilityName) | Sets the ability name for an OH_UdsAppItem instance. |
| OH_UdsFileUri * OH_UdsFileUri_Create () | Creates an OH_UdsFileUri instance and a pointer to it. If this pointer is no longer required, use OH_UdsFileUri_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsFileUri_Destroy (OH_UdsFileUri *pThis) | Destroys an OH_UdsFileUri instance. |
| const char * OH_UdsFileUri_GetType (OH_UdsFileUri *pThis) | Obtains the type ID from an OH_UdsFileUri instance. |
| const char * OH_UdsFileUri_GetFileUri (OH_UdsFileUri *pThis) | Obtains the file URI from an OH_UdsFileUri instance. |
| const char * OH_UdsFileUri_GetFileType (OH_UdsFileUri *pThis) | Obtains the file type from an OH_UdsFileUri instance. |
| int OH_UdsFileUri_SetFileUri (OH_UdsFileUri *pThis, const char *fileUri) | Sets the URI information for an OH_UdsFileUri instance. |
| int OH_UdsFileUri_SetFileType (OH_UdsFileUri *pThis, const char *fileType) | Sets the file type for an OH_UdsFileUri instance. |
| OH_UdsPixelMap * OH_UdsPixelMap_Create () | Creates an OH_UdsPixelMap instance and a pointer to it. If this pointer is no longer required, use OH_UdsPixelMap_Destroy to destroy it. Otherwise, memory leaks may occur. |
| void OH_UdsPixelMap_Destroy (OH_UdsPixelMap *pThis) | Destroys an OH_UdsPixelMap instance. |
| const char * OH_UdsPixelMap_GetType (OH_UdsPixelMap *pThis) | Obtains the type ID from an OH_UdsPixelMap instance. |
| void OH_UdsPixelMap_GetPixelMap (OH_UdsPixelMap *pThis, OH_PixelmapNative *pixelmapNative) | Obtains the pointer to the OH_PixelmapNative instance from an OH_UdsPixelMap instance. |
| int OH_UdsPixelMap_SetPixelMap (OH_UdsPixelMap *pThis, OH_PixelmapNative *pixelmapNative) | Sets the pixel map content for an OH_UdsPixelMap instance. |
| OH_UdsArrayBuffer * OH_UdsArrayBuffer_Create () | Creates an OH_UdsArrayBuffer instance and a pointer to it. If this pointer is no longer required, use OH_UdsArrayBuffer_Destroy to destroy it. Otherwise, memory leaks may occur. |
| int OH_UdsArrayBuffer_Destroy (OH_UdsArrayBuffer *buffer) | Destroys an OH_UdsArrayBuffer instance. |
| int OH_UdsArrayBuffer_SetData (OH_UdsArrayBuffer *buffer, unsigned char *data, unsigned int len) | Sets an OH_UdsArrayBuffer instance. |
| int OH_UdsArrayBuffer_GetData (OH_UdsArrayBuffer *buffer, unsigned char **data, unsigned int *len) | Obtains the custom ArrayBuffer data from an OH_UdsArrayBuffer instance. |
| OH_Utd * OH_Utd_Create (const char *typeId) | Creates an OH_Utd instance and a pointer to it. |
| void OH_Utd_Destroy (OH_Utd *pThis) | Destroys an OH_Utd instance. |
| const char * OH_Utd_GetTypeId (OH_Utd *pThis) | Obtains the type ID from an OH_Utd instance. |
| const char * OH_Utd_GetDescription (OH_Utd *pThis) | Obtains the description from an OH_Utd instance. |
| const char * OH_Utd_GetReferenceUrl (OH_Utd *pThis) | Obtains the URL from an OH_Utd instance. |
| const char * OH_Utd_GetIconFile (OH_Utd *pThis) | Obtains the path of the default icon file from an OH_Utd instance. |
| const char ** OH_Utd_GetBelongingToTypes (OH_Utd *pThis, unsigned int *count) | Obtains the relationships between the data in an OH_Utd instance. |
| const char ** OH_Utd_GetFilenameExtensions (OH_Utd *pThis, unsigned int *count) | Obtains the file name extensions associated with an OH_Utd instance. |
| const char ** OH_Utd_GetMimeTypes (OH_Utd *pThis, unsigned int *count) | Obtains the MIME types associated with an OH_Utd instance. |
| const char ** OH_Utd_GetTypesByFilenameExtension (const char *extension, unsigned int *count) | Obtains the uniform data types based on the file name extensions. |
| const char ** OH_Utd_GetTypesByMimeType (const char *mimeType, unsigned int *count) | Obtains the uniform data types based on the MIME types. |
| bool OH_Utd_BelongsTo (const char *srcTypeId, const char *destTypeId) | Checks whether a UTD belongs to the target UTD. |
| bool 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. |
| bool 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. |
| bool OH_Utd_Equals (OH_Utd *utd1, OH_Utd *utd2) | Checks whether two UTDs are the same. |
| void OH_Utd_DestroyStringList (const char **list, unsigned int count) | Destroys a UTD string list. |
Macro Description
UDMF_METE_GENERAL_CONTENT_FORM
#define UDMF_METE_GENERAL_CONTENT_FORM "general.content-form"
Description
Defines the content widget type.
This type belongs to OBJECT.
Since: 14
UDMF_KEY_BUFFER_LEN
#define UDMF_KEY_BUFFER_LEN (512)
Description
Specifies the minimum length of the buffer that holds the key (unique identifier) of a uniform data object.
Since: 12
UDMF_META_AAC
#define UDMF_META_AAC "general.aac"
Description
Indicates AAC, which belongs to AUDIO.
Since: 12
UDMF_META_AI_IMAGE
#define UDMF_META_AI_IMAGE "com.adobe.illustrator.ai-image"
Description
Indicates adobe Illustrator image (.ai), which belongs to IMAGE.
Since: 12
UDMF_META_AIFC_AUDIO
#define UDMF_META_AIFC_AUDIO "general.aifc-audio"
Description
Indicates AIFC, which belongs to AUDIO.
Since: 12
UDMF_META_AIFF
#define UDMF_META_AIFF "general.aiff"
Description
Indicates AIFF, which belongs to AUDIO.
Since: 12
UDMF_META_ALAC
#define UDMF_META_ALAC "general.alac"
Description
Indicates ALAC, which belongs to AUDIO.
Since: 12
UDMF_META_ARCHIVE
#define UDMF_META_ARCHIVE "general.archive"
Description
Indicates the generic archive file type, which belongs to OBJECT.
Since: 12
UDMF_META_AU_AUDIO
#define UDMF_META_AU_AUDIO "general.au-audio"
Description
Indicates the AU format, which belongs to AUDIO.
Since: 12
UDMF_META_AUDIO
#define UDMF_META_AUDIO "general.audio"
Description
Indicates the generic audio type, which belongs to MEDIA.
Since: 12
UDMF_META_AVI
#define UDMF_META_AVI "general.avi"
Description
Indicates AVI, which belongs to VIDEO.
Since: 12
UDMF_META_AZW
#define UDMF_META_AZW "com.amazon.azw"
Description
Indicates AZW, which belongs to EBOOK.
Since: 12
UDMF_META_AZW3
#define UDMF_META_AZW3 "com.amazon.azw3"
Description
Indicates AZW3, which belongs to EBOOK.
Since: 12
UDMF_META_BMP
#define UDMF_META_BMP "com.microsoft.bmp"
Description
Indicates BMP, which belongs to IMAGE.
Since: 12
UDMF_META_BZ2_ARCHIVE
#define UDMF_META_BZ2_ARCHIVE "general.bz2-archive"
Description
Indicates BZ2, which belongs to ARCHIVE.
Since: 12
UDMF_META_C_HEADER
#define UDMF_META_C_HEADER "general.c-header"
Description
Indicates a header file in C, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_C_PLUS_PLUS_HEADER
#define UDMF_META_C_PLUS_PLUS_HEADER "general.c-plus-plus-header"
Description
Indicates a header file in C++, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_C_PLUS_PLUS_SOURCE
#define UDMF_META_C_PLUS_PLUS_SOURCE "general.c-plus-plus-source"
Description
Indicates the source code in C++, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_C_SOURCE
#define UDMF_META_C_SOURCE "general.c-source"
Description
Indicates the source code in C, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_CALENDAR
#define UDMF_META_CALENDAR "general.calendar"
Description
Indicates the generic calendar type, which belongs to OBJECT.
Since: 12
UDMF_META_COMPOSITE_OBJECT
#define UDMF_META_COMPOSITE_OBJECT "general.composite-object"
Description
Indicates the generic composite content type. For example, a PDF file that contains text and image. This type belongs to OBJECT.
Since: 12
UDMF_META_CONTACT
#define UDMF_META_CONTACT "general.contact"
Description
Indicates the generic contact type. This type belongs to OBJECT.
Since: 12
UDMF_META_CSH_SCRIPT
#define UDMF_META_CSH_SCRIPT "general.csh-script"
Description
Indicates a C shell script, which belongs to SHELL_SCRIPT.
Since: 12
UDMF_META_DATABASE
#define UDMF_META_DATABASE "general.database"
Description
Indicates the generic database file type, which belongs to OBJECT.
Since: 12
UDMF_META_DIRECTORY
#define UDMF_META_DIRECTORY "general.directory"
Description
Indicates the generic directory type, which belongs to ENTITY.
Since: 12
UDMF_META_DISK_IMAGE
#define UDMF_META_DISK_IMAGE "general.disk-image"
Description
Indicates the generic type of any file that can be mounted as a volume. This type belongs to ARCHIVE.
Since: 12
UDMF_META_EBOOK
#define UDMF_META_EBOOK "general.ebook"
Description
Indicates the generic eBook file format, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_EFX_FAX
#define UDMF_META_EFX_FAX "com.js.efx-fax"
Description
Indicates the EFX file format, which belongs to FAX.
Since: 12
UDMF_META_ENCAPSULATED_POSTSCRIPT
#define UDMF_META_ENCAPSULATED_POSTSCRIPT "com.adobe.encapsulated-postscript"
Description
Indicates encapsulated PostScript, which belongs to POSTSCRIPT.
Since: 12
UDMF_META_ENTITY
#define UDMF_META_ENTITY "general.entity"
Description
Indicates the generic type that represents all physical storage types. It is used to define physical properties of a type. This type is uncategorized.
Since: 12
UDMF_META_EPUB
#define UDMF_META_EPUB "general.epub"
Description
Indicates EPUB, which belongs to EBOOK.
Since: 12
UDMF_META_EXCEL
#define UDMF_META_EXCEL "com.microsoft.excel.xls"
Description
Indicates Microsoft Excel, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_EXECUTABLE
#define UDMF_META_EXECUTABLE "general.executable"
Description
Indicates the generic type of all executable files, which belongs to OBJECT.
Since: 12
UDMF_META_FAX
#define UDMF_META_FAX "general.fax"
Description
Indicates the generic fax type, which belongs to IMAGE.
Since: 12
UDMF_META_FLAC
#define UDMF_META_FLAC "general.flac"
Description
Indicates FLAC, which belongs to AUDIO.
Since: 12
UDMF_META_FLASHPIX_IMAGE
#define UDMF_META_FLASHPIX_IMAGE "com.kodak.flashpix.image"
Description
Indicates the FlashPix image format, which belongs to IMAGE.
Since: 12
UDMF_META_FOLDER
#define UDMF_META_FOLDER "general.folder"
Description
Indicates the generic folder type, which belongs to DIRECTORY.
Since: 12
UDMF_META_FONT
#define UDMF_META_FONT "general.font"
Description
Indicates the generic font type, which belongs to OBJECT.
Since: 12
UDMF_META_GENERAL_FILE
#define UDMF_META_GENERAL_FILE "general.file"
Description
Indicates the generic file type, which belongs to ENTITY.
Since: 12
UDMF_META_GENERAL_FILE_URI
#define UDMF_META_GENERAL_FILE_URI "general.file-uri"
Description
Indicates the file address type, which belongs to TEXT.
Since: 13
UDMF_META_GNU_TAR_ARCHIVE
#define UDMF_META_GNU_TAR_ARCHIVE "org.gnu.gnu-tar-archive"
Description
Indicates GUN archive, which belongs to ARCHIVE.
Since: 12
UDMF_META_GNU_ZIP_ARCHIVE
#define UDMF_META_GNU_ZIP_ARCHIVE "org.gnu.gnu-zip-archive"
Description
Indicates GZIP archive, which belongs to ARCHIVE.
Since: 12
UDMF_META_GNU_ZIP_TAR_ARCHIVE
#define UDMF_META_GNU_ZIP_TAR_ARCHIVE "org.gnu.gnu-zip-tar-archive"
Description
Indicates GZIP TAR, which belongs to ARCHIVE.
Since: 12
UDMF_META_HTML
#define UDMF_META_HTML "general.html"
Description
Indicates HTML, which belongs to TEXT.
Since: 12
UDMF_META_HYPERLINK
#define UDMF_META_HYPERLINK "general.hyperlink"
Description
Indicates Hyperlink, which belongs to TEXT.
Since: 12
UDMF_META_ICO
#define UDMF_META_ICO "com.microsoft.ico"
Description
Indicates Windows icon type, which belongs to IMAGE.
Since: 12
UDMF_META_ICS
#define UDMF_META_ICS "general.ics"
Description
Indicates the ICS format, which belongs to CALENDAR and TEXT.
Since: 12
UDMF_META_IMAGE
#define UDMF_META_IMAGE "general.image"
Description
Indicates the generic image type, which belongs to MEDIA.
Since: 12
UDMF_META_JAVA_ARCHIVE
#define UDMF_META_JAVA_ARCHIVE "com.sun.java-archive"
Description
Indicates JAR (Java archive), which belongs to ARCHIVE and EXECUTABLE.
Since: 12
UDMF_META_JAVA_SCRIPT
#define UDMF_META_JAVA_SCRIPT "general.java-script"
Description
Indicates JavaScript source code, which belongs to SCRIPT.
Since: 12
UDMF_META_JAVA_SOURCE
#define UDMF_META_JAVA_SOURCE "general.java-source"
Description
Indicates Java source code, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_JFX_FAX
#define UDMF_META_JFX_FAX "com.j2.jfx-fax"
Description
Indicates the J2 jConnect fax file format, which belongs to FAX.
Since: 12
UDMF_META_JPEG
#define UDMF_META_JPEG "general.jpeg"
Description
Indicates JPEG, which belongs to IMAGE.
Since: 12
UDMF_META_KFX
#define UDMF_META_KFX "com.amazon.kfx"
Description
Indicates KFX, which belongs to EBOOK.
Since: 12
UDMF_META_LOCATION
#define UDMF_META_LOCATION "general.location"
Description
Indicates location data type, which belongs to NAVIGATION.
Since: 12
UDMF_META_MARKDOWN
#define UDMF_META_MARKDOWN "general.markdown"
Description
Indicates Markdown, which belongs to PLAIN_TEXT.
Since: 12
UDMF_META_MEDIA
#define UDMF_META_MEDIA "general.media"
Description
Indicates the generic media type, which belongs to OBJECT.
Since: 12
UDMF_META_MESSAGE
#define UDMF_META_MESSAGE "general.message"
Description
Indicates the generic message type, which belongs to OBJECT.
Since: 12
UDMF_META_MOBI
#define UDMF_META_MOBI "com.amazon.mobi"
Description
Indicates MOBI, which belongs to EBOOK.
Since: 12
UDMF_META_MP3
#define UDMF_META_MP3 "general.mp3"
Description
Indicates MP3, which belongs to AUDIO.
Since: 12
UDMF_META_MPEG
#define UDMF_META_MPEG "general.mpeg"
Description
Indicates MPGE-1 or MPGE-2, which belongs to VIDEO.
Since: 12
UDMF_META_MPEG4
#define UDMF_META_MPEG4 "general.mpeg-4"
Description
Indicates MPGE-4, which belongs to VIDEO.
Since: 12
UDMF_META_NAVIGATION
#define UDMF_META_NAVIGATION "general.navigation"
Description
Generic navigation data type.
This type belongs to OBJECT.
Since: 12
UDMF_META_OBJECT
#define UDMF_META_OBJECT "general.object"
Description
Indicates the generic type that represents all logical content types. It is used to describe the functional features of a type. This type is uncategorized.
Since: 12
UDMF_META_OGG
#define UDMF_META_OGG "general.ogg"
Description
OGG.
This type belongs to AUDIO.
Since: 12
UDMF_META_OPENDOCUMENT
#define UDMF_META_OPENDOCUMENT "org.oasis.opendocument"
Description
OpenDocument format for Office applications.
This type belongs to ARCHIVE.
Since: 12
UDMF_META_OPENDOCUMENT_FORMULA
#define UDMF_META_OPENDOCUMENT_FORMULA "org.oasis.opendocument.formula"
Description
OpenDocument format for formula.
This type belongs to OPENDOCUMENT.
Since: 12
UDMF_META_OPENDOCUMENT_GRAPHICS
#define UDMF_META_OPENDOCUMENT_GRAPHICS "org.oasis.opendocument.graphics"
Description
OpenDocument format for graphics.
This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENDOCUMENT_PRESENTATION
#define UDMF_META_OPENDOCUMENT_PRESENTATION "org.oasis.opendocument.presentation"
Description
OpenDocument format for presentations.
This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENDOCUMENT_SPREADSHEET
#define UDMF_META_OPENDOCUMENT_SPREADSHEET "org.oasis.opendocument.spreadsheet"
Description
OpenDocument format for spreadsheets.
This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENDOCUMENT_TEXT
#define UDMF_META_OPENDOCUMENT_TEXT "org.oasis.opendocument.text"
Description
OpenDocument format for word processing (text) documents.
This type belongs to OPENDOCUMENT and COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENEXR_IMAGE
#define UDMF_META_OPENEXR_IMAGE "com.ilm.openexr-image"
Description
OpenXR image format.
This type belongs to IMAGE.
Since: 12
UDMF_META_OPENHARMONY_APP_ITEM
#define UDMF_META_OPENHARMONY_APP_ITEM "openharmony.app-item"
Description
Home screen icon defined for the system.
This type belongs to OBJECT.
Since: 12
UDMF_META_OPENHARMONY_ATOMIC_SERVICE
#define UDMF_META_OPENHARMONY_ATOMIC_SERVICE "openharmony.atomic-service"
Description
Atomic service type defined for the system.
This type belongs to OBJECT.
Since: 12
UDMF_META_OPENHARMONY_FORM
#define UDMF_META_OPENHARMONY_FORM "openharmony.form"
Description
Widget defined for the system.
This type belongs to OBJECT.
Since: 12
UDMF_META_OPENHARMONY_HAP
#define UDMF_META_OPENHARMONY_HAP "openharmony.hap"
Description
Ability package defined for the system.
This type belongs to OPENHARMONY_PACKAGE.
Since: 12
UDMF_META_OPENHARMONY_HDOC
#define UDMF_META_OPENHARMONY_HDOC "openharmony.hdoc"
Description
Memo format defined for the system.
This type belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENHARMONY_HINOTE
#define UDMF_META_OPENHARMONY_HINOTE "openharmony.hinote"
Description
Note format defined for the system.
This type belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENHARMONY_PACKAGE
#define UDMF_META_OPENHARMONY_PACKAGE "openharmony.package"
Description
Package (compressed folder) defined for the system.
This type belongs to DIRECTORY.
Since: 12
UDMF_META_OPENHARMONY_PIXEL_MAP
#define UDMF_META_OPENHARMONY_PIXEL_MAP "openharmony.pixel-map"
Description
Pixel map defined for the system.
This type belongs to IMAGE.
Since: 12
UDMF_META_OPENHARMONY_STYLED_STRING
#define UDMF_META_OPENHARMONY_STYLED_STRING "openharmony.styled-string"
Description
Style string type defined for the system.
This type belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_OPENHARMONY_WANT
#define UDMF_META_OPENHARMONY_WANT "openharmony.want"
Description
Want defined for the system.
This type belongs to OBJECT.
Since: 12
UDMF_META_OPENTYPE_FONT
#define UDMF_META_OPENTYPE_FONT "general.opentype-font"
Description
Indicates the OpenType font format, which belongs to FONT.
Since: 12
UDMF_META_OPENXML
#define UDMF_META_OPENXML "org.openxmlformats.openxml"
Description
Indicates OpenXML, which belongs to ARCHIVE.
Since: 12
UDMF_META_PCM
#define UDMF_META_PCM "general.pcm"
Description
Indicates PCM, which belongs to AUDIO.
Since: 12
UDMF_META_PDF
#define UDMF_META_PDF "com.adobe.pdf"
Description
Indicates PDF, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_PERL_SCRIPT
#define UDMF_META_PERL_SCRIPT "general.perl-script"
Description
Indicates a Perl script, which belongs to SHELL_SCRIPT.
Since: 12
UDMF_META_PHOTOSHOP_IMAGE
#define UDMF_META_PHOTOSHOP_IMAGE "com.adobe.photoshop-image"
Description
Indicates an Adobe Photoshop image, which belongs to IMAGE.
Since: 12
UDMF_META_PHP_SCRIPT
#define UDMF_META_PHP_SCRIPT "general.php-script"
Description
Indicates a PHP script, which belongs to SHELL_SCRIPT.
Since: 12
UDMF_META_PLAIN_TEXT
#define UDMF_META_PLAIN_TEXT "general.plain-text"
Description
Indicates text without specific encoding or identifier, which belongs to TEXT.
Since: 12
UDMF_META_PNG
#define UDMF_META_PNG "general.png"
Description
Indicates PNG, which belongs to IMAGE.
Since: 12
UDMF_META_PORTABLE_EXECUTABLE
#define UDMF_META_PORTABLE_EXECUTABLE "com.microsoft.portable-executable"
Description
Indicates the Microsoft Windows portable executable format, which belongs to EXECUTABLE.
Since: 12
UDMF_META_POSTSCRIPT
#define UDMF_META_POSTSCRIPT "com.adobe.postscript"
Description
Indicates PostScript, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_POSTSCRIPT_FONT
#define UDMF_META_POSTSCRIPT_FONT "com.adobe.postscript-font"
Description
Indicates the PostScript font format, which belongs to FONT.
Since: 12
UDMF_META_POSTSCRIPT_PFA_FONT
#define UDMF_META_POSTSCRIPT_PFA_FONT "com.adobe.postscript-pfa-font"
Description
Indicates Adobe Type 1 font format, which belongs to FONT.
Since: 12
UDMF_META_POSTSCRIPT_PFB_FONT
#define UDMF_META_POSTSCRIPT_PFB_FONT "com.adobe.postscript-pfb-font"
Description
Indicates PostScript Font Binary font format, which belongs to FONT.
Since: 12
UDMF_META_PPT
#define UDMF_META_PPT "com.microsoft.powerpoint.ppt"
Description
Indicates Microsoft PowerPoint presentation format, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_PRESENTATIONML_PRESENTATION
#define UDMF_META_PRESENTATIONML_PRESENTATION "org.openxmlformats.presentationml.presentation"
Description
Indicates PresentationML format, which belongs to OPENXML and COMPOSITE_OBJECT.
Since: 12
UDMF_META_PYTHON_SCRIPT
#define UDMF_META_PYTHON_SCRIPT "general.python-script"
Description
Indicates a Python script, which belongs to SHELL_SCRIPT.
Since: 12
UDMF_META_RAW_IMAGE
#define UDMF_META_RAW_IMAGE "general.raw-image"
Description
Indicates a raw image, which belongs to IMAGE.
Since: 12
UDMF_META_REALAUDIO
#define UDMF_META_REALAUDIO "com.real.realaudio"
Description
Indicates RealAudio, which belongs to AUDIO.
Since: 12
UDMF_META_REALMEDIA
#define UDMF_META_REALMEDIA "com.real.realmedia"
Description
Indicates RealMedia format, which belongs to VIDEO.
Since: 12
UDMF_META_RUBY_SCRIPT
#define UDMF_META_RUBY_SCRIPT "general.ruby-script"
Description
Indicates a Ruby script, which belongs to SHELL_SCRIPT.
Since: 12
UDMF_META_SCRIPT
#define UDMF_META_SCRIPT "general.script"
Description
Indicates the source code in any scripting language, which belongs to SOURCE_CODE.
Since: 12
UDMF_META_SD2_AUDIO
#define UDMF_META_SD2_AUDIO "com.digidesign.sd2-audio"
Description
Indicates SDII, which belongs to AUDIO.
Since: 12
UDMF_META_SGI_IMAGE
#define UDMF_META_SGI_IMAGE "com.sgi.sgi-image"
Description
Indicates SGI format, which belongs to IMAGE.
Since: 12
UDMF_META_SHELL_SCRIPT
#define UDMF_META_SHELL_SCRIPT "general.shell-script"
Description
Indicates a Shell script, which belongs to SCRIPT.
Since: 12
UDMF_META_SMIL
#define UDMF_META_SMIL "com.real.smil"
Description
Indicates SMIL, which belongs to XML.
Since: 12
UDMF_META_SOURCE_CODE
#define UDMF_META_SOURCE_CODE "general.source-code"
Description
Indicates the generic source code type, which belongs to PLAIN_TEXT.
Since: 12
UDMF_META_SPREADSHEETML_SHEET
#define UDMF_META_SPREADSHEETML_SHEET "org.openxmlformats.spreadsheetml.sheet"
Description
Indicates the SpreadsheetML format, which belongs to OPENXML and COMPOSITE_OBJECT.
Since: 12
UDMF_META_STUFFIT_ARCHIVE
#define UDMF_META_STUFFIT_ARCHIVE "com.allume.stuffit-archive"
Description
Indicates the Stuffit compression format (stuffit archive), which belongs to ARCHIVE.
Since: 12
UDMF_META_SUN_JAVA_CLASS
#define UDMF_META_SUN_JAVA_CLASS "com.sun.java-class"
Description
Indicates the Java class file format, which belongs to EXECUTABLE.
Since: 12
UDMF_META_SYMLINK
#define UDMF_META_SYMLINK "general.symlink"
Description
Indicates the generic symbolic type, which belongs to ENTITY.
Since: 12
UDMF_META_TAR_ARCHIVE
#define UDMF_META_TAR_ARCHIVE "general.tar-archive"
Description
Indicates TAR, which belongs to ARCHIVE.
Since: 12
UDMF_META_TEXT
#define UDMF_META_TEXT "general.text"
Description
Indicates the generic text type, which belongs to OBJECT.
Since: 12
UDMF_META_TGA_IMAGE
#define UDMF_META_TGA_IMAGE "com.truevision.tga-image"
Description
Indicates TGA, which belongs to IMAGE.
Since: 12
UDMF_META_TIFF
#define UDMF_META_TIFF "general.tiff"
Description
Indicates TIFF, which belongs to IMAGE.
Since: 12
UDMF_META_TRUETYPE_COLLECTION_FONT
#define UDMF_META_TRUETYPE_COLLECTION_FONT "general.truetype-collection-font"
Description
Indicates the TrueType Collection font format, which belongs to FONT.
Since: 12
UDMF_META_TRUETYPE_FONT
#define UDMF_META_TRUETYPE_FONT "general.truetype-font"
Description
Indicates the TrueType font format, which belongs to FONT.
Since: 12
UDMF_META_TYPE_SCRIPT
#define UDMF_META_TYPE_SCRIPT "general.type-script"
Description
Indicates TypeScript source code, which belongs to SCRIPT.
Since: 12
UDMF_META_VCARD
#define UDMF_META_VCARD "general.vcard"
Description
Indicates the generic electronic business card type, which belongs to OBJECT.
Since: 12
UDMF_META_VCS
#define UDMF_META_VCS "general.vcs"
Description
Indicates the VCS format, which belongs to CALENDAR and TEXT.
Since: 12
UDMF_META_VIDEO
#define UDMF_META_VIDEO "general.video"
Description
Indicates the generic video type, which belongs to MEDIA.
Since: 12
UDMF_META_VIDEO_3GPP
#define UDMF_META_VIDEO_3GPP "general.3gpp"
Description
Indicates 3GP (3GPP file format), which belongs to VIDEO.
Since: 12
UDMF_META_VIDEO_3GPP2
#define UDMF_META_VIDEO_3GPP2 "general.3gpp2"
Description
Indicates 3G2 (3GPP2 file format), which belongs to VIDEO.
Since: 12
UDMF_META_WAVEFORM_AUDIO
#define UDMF_META_WAVEFORM_AUDIO "com.microsoft.waveform-audio"
Description
Indicates Windows Waveform, which belongs to AUDIO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WAX
#define UDMF_META_WINDOWS_MEDIA_WAX "com.microsoft.windows-media-wax"
Description
Indicates Windows WAX, which belongs to AUDIO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WM
#define UDMF_META_WINDOWS_MEDIA_WM "com.microsoft.windows-media-wm"
Description
Indicates Windows WM format, which belongs to VIDEO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WMA
#define UDMF_META_WINDOWS_MEDIA_WMA "com.microsoft.windows-media-wma"
Description
Indicates Windows WMA, which belongs to AUDIO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WMP
#define UDMF_META_WINDOWS_MEDIA_WMP "com.microsoft.windows-media-wmp"
Description
Indicates Windows WMP, which belongs to VIDEO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WMV
#define UDMF_META_WINDOWS_MEDIA_WMV "com.microsoft.windows-media-wmv"
Description
Indicates Windows WMV, which belongs to VIDEO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WMX
#define UDMF_META_WINDOWS_MEDIA_WMX "com.microsoft.windows-media-wmx"
Description
Indicates Windows WMX, which belongs to VIDEO.
Since: 12
UDMF_META_WINDOWS_MEDIA_WVX
#define UDMF_META_WINDOWS_MEDIA_WVX "com.microsoft.windows-media-wvx"
Description
Indicates Windows WVX, which belongs to VIDEO.
Since: 12
UDMF_META_WORD_DOC
#define UDMF_META_WORD_DOC "com.microsoft.word.doc"
Description
Indicates Microsoft Word, which belongs to COMPOSITE_OBJECT.
Since: 12
UDMF_META_WORDPROCESSINGML_DOCUMENT
#define UDMF_META_WORDPROCESSINGML_DOCUMENT "org.openxmlformats.wordprocessingml.document"
Description
Indicates WordProcessingML format, which belongs to OPENXML and COMPOSITE_OBJECT.
Since: 12
UDMF_META_XBITMAP_IMAGE
#define UDMF_META_XBITMAP_IMAGE "general.xbitmap-image"
Description
Indicates X BitMAP (XBM) used in the X Window system (X11), which belongs to IMAGE.
Since: 12
UDMF_META_XML
#define UDMF_META_XML "general.xml"
Description
Indicates XML, which belongs to TEXT.
Since: 12
UDMF_META_ZIP_ARCHIVE
#define UDMF_META_ZIP_ARCHIVE "general.zip-archive"
Description
Indicates ZIP, which belongs to ARCHIVE.
Since: 12
Type Description
OH_UdsContentForm
typedef struct OH_UdsContentForm OH_UdsContentForm
Description
Defines a struct for the uniform data of the content widget type.
Since: 14
OH_UdmfData
typedef struct OH_UdmfData OH_UdmfData
Description
Defines a struct for a uniform data object.
Since: 12
OH_UdmfProperty
typedef struct OH_UdmfProperty OH_UdmfProperty
Description
Defines a struct for a data record property in a uniform data object.
Since: 12
OH_UdmfRecord
typedef struct OH_UdmfRecord OH_UdmfRecord
Description
Defines a struct for a data record in a uniform data object.
Since: 12
OH_UdmfRecordProvider
typedef struct OH_UdmfRecordProvider OH_UdmfRecordProvider
Description
Represents the data record provider in a uniform data object.
Since: 13
OH_UdmfRecordProvider_GetData
typedef void*(* OH_UdmfRecordProvider_GetData) (void *context, const char *type)
Description
Defines a callback function used to obtain data by type. This callback will be invoked to return the data obtained from OH_UdmfRecord.
Since: 13
Parameters
| Name | Description |
|---|---|
| context | Pointer to the context set by OH_UdmfRecordProvider_SetData. |
| type | Pointer to the type of the data to obtain. For details, see udmf_meta.h. |
Returns
Uniform data obtained.
OH_UdsAppItem
typedef struct OH_UdsAppItem OH_UdsAppItem
Description
Defines a struct for the uniform data of the home screen icon type.
Since: 12
OH_UdsArrayBuffer
typedef struct OH_UdsArrayBuffer OH_UdsArrayBuffer
Description
Defines a struct for the ArrayBuffer type.
Since: 13
OH_UdsFileUri
typedef struct OH_UdsFileUri OH_UdsFileUri
Description
Defines a struct for the file URI type.
Since: 13
OH_UdsHtml
typedef struct OH_UdsHtml OH_UdsHtml
Description
Defines a struct for the uniform data of the Hypertext Markup Language (HTML) type.
Since: 12
OH_UdsHyperlink
typedef struct OH_UdsHyperlink OH_UdsHyperlink
Description
Defines a struct for the uniform data of the hyperlink type.
Since: 12
OH_UdsPixelMap
typedef struct OH_UdsPixelMap OH_UdsPixelMap
Description
Defines a struct for the pixel map type.
Since: 13
OH_UdsPlainText
typedef struct OH_UdsPlainText OH_UdsPlainText
Description
Defines a struct for the uniform data of the plaintext type.
Since: 12
OH_Utd
typedef struct OH_Utd OH_Utd
Description
Defines a struct for a UTD.
Since: 12
Udmf_ErrCode
typedef enum Udmf_ErrCode Udmf_ErrCode
Description
Defines an enum for error codes.
Since: 12
Udmf_Intention
typedef enum Udmf_Intention Udmf_Intention
Description
Defines an enum for UDMF data channel types.
Since: 12
Udmf_ShareOption
typedef enum Udmf_ShareOption Udmf_ShareOption
Description
Defines an enum for the scopes of the uniform data to be used on a device.
Since: 12
UdmfData_Finalize
typedef void(* UdmfData_Finalize) (void *context)
Description
Defines a callback function used to release the context. This callback is invoked when the OH_UdmfRecordProvider instance is destroyed.
Since: 13
Parameters
| Name | Description |
|---|---|
| context | Pointer to the context to release. |
Enum Description
Udmf_ErrCode
enum Udmf_ErrCode
Description
Enumerates the error codes.
Since: 12
| Value | Description |
|---|---|
| UDMF_E_OK | The operation is successful. |
| UDMF_ERR | Common error. |
| UDMF_E_INVALID_PARAM | Invalid parameter. |
Udmf_Intention
enum Udmf_Intention
Description
Enumerates the UDMF data channel types.
Since: 12
| Value | Description |
|---|---|
| UDMF_INTENTION_DRAG | Channel for dragging data. |
| UDMF_INTENTION_PASTEBOARD | Channel for clipboard data. |
Udmf_ShareOption
enum Udmf_ShareOption
Description
Enumerates the scopes of the uniform data to be used on a device.
Since: 12
| Value | Description |
|---|---|
| SHARE_OPTIONS_INVALID | Invalid use. |
| SHARE_OPTIONS_IN_APP | Use the uniform data only in the same application of a device. |
| SHARE_OPTIONS_CROSS_APP | Use the uniform data across applications of a device. |
Function Description
OH_UdmfRecord_AddContentForm()
int OH_UdmfRecord_AddContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )
Description
Adds data of the OH_UdsContentForm type to an OH_UdmfRecord instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| contentForm | Pointer to the OH_UdsContentForm instance to add. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetContentForm()
int OH_UdmfRecord_GetContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )
Description
Obtains data of the OH_UdsContentForm type from an OH_UdmfRecord instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| contentForm | Pointer to the OH_UdsContentForm instance obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_Create()
OH_UdsContentForm* OH_UdsContentForm_Create ()
Description
Creates an OH_UdsContentForm instance and a pointer to it.
Since: 14
Returns
Returns a pointer to the OH_UdsContentForm instance created if the operation is successful; return nullptr otherwise.
See
OH_UdsContentForm_Destroy()
void OH_UdsContentForm_Destroy (OH_UdsContentForm* pThis)
Description
Destroys an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsContentForm instance to destroy. |
See
OH_UdsContentForm_GetAppIcon()
int OH_UdsContentForm_GetAppIcon (OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len )
Description
Obtains the application icon data from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| appIcon | Double pointer to the binary application icon data obtained. |
| len | Pointer to the length of the binary application icon data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
Returns UDMF_ERR if an internal system error occurs.
See
OH_UdsContentForm_GetAppName()
const char* OH_UdsContentForm_GetAppName (OH_UdsContentForm* pThis)
Description
Obtains the application name from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
Returns
Returns the pointer to the application name obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsContentForm_GetDescription()
const char* OH_UdsContentForm_GetDescription (OH_UdsContentForm* pThis)
Description
Obtains the description from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
Returns
Returns the pointer to the description string obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsContentForm_GetLinkUri()
const char* OH_UdsContentForm_GetLinkUri (OH_UdsContentForm* pThis)
Description
Obtains the hyperlink information from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
Returns
Returns the pointer to the hyperlink obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsContentForm_GetThumbData()
int OH_UdsContentForm_GetThumbData (OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len )
Description
Obtains image data from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| thumbData | Double pointer to the binary image data obtained. |
| len | Pointer to the length of the binary image data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
Returns UDMF_ERR if an internal system error occurs.
See
OH_UdsContentForm_GetTitle()
const char* OH_UdsContentForm_GetTitle (OH_UdsContentForm* pThis)
Description
Obtains the title from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
Returns
Returns the pointer to the title string obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsContentForm_GetType()
const char* OH_UdsContentForm_GetType (OH_UdsContentForm* pThis)
Description
Obtains the type ID from an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsContentForm_SetAppIcon()
int OH_UdsContentForm_SetAppIcon (OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len )
Description
Sets the application icon data for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| appIcon | Pointer to the binary application icon data to set. |
| len | Length of the binary application icon data to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_SetAppName()
int OH_UdsContentForm_SetAppName (OH_UdsContentForm* pThis, const char* appName )
Description
Sets the application name for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| appName | Pointer to the application name to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_SetDescription()
int OH_UdsContentForm_SetDescription (OH_UdsContentForm* pThis, const char* description )
Description
Sets the description for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| description | Pointer to the description to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_SetLinkUri()
int OH_UdsContentForm_SetLinkUri (OH_UdsContentForm* pThis, const char* linkUri )
Description
Sets the hyperlink data for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| linkUri | Pointer to the hyperlink to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_SetThumbData()
int OH_UdsContentForm_SetThumbData (OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len )
Description
Sets the image data for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| thumbData | Pointer to the binary image data to set. |
| len | Length of the binary image data to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsContentForm_SetTitle()
int OH_UdsContentForm_SetTitle (OH_UdsContentForm* pThis, const char* title )
Description
Sets the title for an OH_UdsContentForm instance.
Since: 14
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsContentForm instance. |
| title | Pointer to the title to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_Udmf_GetUnifiedData()
int OH_Udmf_GetUnifiedData (const char* key, Udmf_Intention intention, OH_UdmfData* unifiedData )
Description
Obtains an OH_UdmfData instance from the UDMF database.
Since: 12
Parameters
| Name | Description |
|---|---|
| key | Pointer to the identifier of the data in the database. |
| intention | Type of the data channel. For details, see Udmf_Intent. |
| unifiedData | Pointer to the OH_UdmfData obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_Udmf_SetUnifiedData()
int OH_Udmf_SetUnifiedData (Udmf_Intention intention, OH_UdmfData* unifiedData, char* key, unsigned int keyLen )
Description
Sets an OH_UdmfData instance in the UDMF database.
Since: 12
Parameters
| Name | Description |
|---|---|
| intention | Type of the data channel. For details, see Udmf_Intent. |
| unifiedData | Pointer to the OH_UdmfData data to set. |
| key | Pointer to the key that uniquely identifies the data in the database. |
| keyLen | Length of the key. The memory size must be greater than or equal to 512 bytes. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfData_AddRecord()
int OH_UdmfData_AddRecord (OH_UdmfData* pThis, OH_UdmfRecord* record )
Description
Adds an OH_UdmfRecord to an OH_UdmfData instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfData instance. |
| record | Pointer to the OH_UdmfRecord instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfData_Create()
OH_UdmfData* OH_UdmfData_Create ()
Description
Creates an OH_UdmfData instance and a pointer to it. If this pointer is no longer required, use OH_UdmfData_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdmfData instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdmfData_Destroy()
void OH_UdmfData_Destroy (OH_UdmfData* pThis)
Description
Destroys an OH_UdmfData instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfData instance to destroy. |
See
OH_UdmfData_GetPrimaryHtml()
int OH_UdmfData_GetPrimaryHtml (OH_UdmfData* data, OH_UdsHtml* html )
Description
Obtains the first OH_UdsHtml data from an OH_UdmfData instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| data | Pointer to the OH_UdmfData instance. |
| html | Pointer to the OH_UdsHtml data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfData_GetPrimaryPlainText()
int OH_UdmfData_GetPrimaryPlainText (OH_UdmfData* data, OH_UdsPlainText* plainText )
Description
Obtains the first OH_UdsPlainText data from an OH_UdmfData instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| data | Pointer to the OH_UdmfData instance. |
| plainText | Pointer to the OH_UdsPlainText data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfData_GetRecord()
OH_UdmfRecord* OH_UdmfData_GetRecord (OH_UdmfData* data, unsigned int index )
Description
Obtains the specified data record from an OH_UdmfData instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| data | Pointer to the OH_UdmfData instance. |
| index | Index of the OH_UdmfRecord in the OH_UdmfData]( #oh_udmfdata) instance. |
Returns
Returns a pointer to the OH_UdmfRecord instance obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfData_GetRecordCount()
int OH_UdmfData_GetRecordCount (OH_UdmfData* data)
Description
Obtains the number of data records contained in an OH_UdmfData instance.
Parameters
| Name | Description |
|---|---|
| data | Pointer to the target OH_UdmfData instance. |
OH_UdmfData_GetRecords()
OH_UdmfRecord** OH_UdmfData_GetRecords (OH_UdmfData* pThis, unsigned int* count )
Description
Obtains all records contained in an OH_UdmfData instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdmfData instance. |
| count | Pointer to the number of records obtained. |
Returns
Returns OH_UdmfRecord obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfData_GetTypes()
char** OH_UdmfData_GetTypes (OH_UdmfData* pThis, unsigned int* count )
Description
Obtains all data types in an OH_UdmfData instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdmfData instance. |
| count | Pointer to the number of data types obtained. |
Returns
Returns the data types obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfData_HasType()
bool OH_UdmfData_HasType (OH_UdmfData* pThis, const char* type )
Description
Checks whether the specified type exists in an OH_UdmfData instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdmfData instance. |
| type | Pointer to the type to check. |
Returns
Returns true if the data type exists; returns false otherwise.
See
OH_UdmfData_IsLocal()
bool OH_UdmfData_IsLocal (OH_UdmfData* data)
Description
Checks whether an OH_UdmfData instance is from the local device.
Since: 13
Parameters
| Name | Description |
|---|---|
| data | Pointer to the OH_UdmfData instance. |
Returns
Returns true if the data is from the local device; returns false otherwise.
See
OH_UdmfProperty_Create()
OH_UdmfProperty* OH_UdmfProperty_Create (OH_UdmfData* unifiedData)
Description
Creates an OH_UdmfProperty instance and a pointer to it. If this pointer is no longer required, use OH_UdmfProperty_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Parameters
| Name | Description |
|---|---|
| unifiedData | Pointer to the OH_UdmfData instance. |
Returns
Returns a pointer to the OH_UdmfProperty instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdmfProperty_Destroy()
void OH_UdmfProperty_Destroy (OH_UdmfProperty* pThis)
Description
Destroys an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance to destroy. |
See
OH_UdmfProperty_GetExtrasIntParam()
int OH_UdmfProperty_GetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int defaultValue )
Description
Obtains the customized extra integer parameter from an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
| key | Pointer to the key of the parameter to obtain. |
| defaultValue | Default value to be returned if the parameter fails to be obtained. |
Returns
Returns the integer value obtained if the operation is successful; returns defaultValue if the operation fails.
See
OH_UdmfProperty_GetExtrasStringParam()
const char* OH_UdmfProperty_GetExtrasStringParam (OH_UdmfProperty* pThis, const char* key )
Description
Obtains the customized extra string parameter from an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
| key | Pointer to the key of the parameter to obtain. |
Returns
Returns a pointer to the string value obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfProperty_GetShareOption()
Udmf_ShareOption OH_UdmfProperty_GetShareOption (OH_UdmfProperty* pThis)
Description
Obtains the share option from an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
Returns
Returns the Udmf_ShareOption obtained.
See
OH_UdmfProperty_GetTag()
const char* OH_UdmfProperty_GetTag (OH_UdmfProperty* pThis)
Description
Obtains the custom tag value from an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
Returns
Returns a pointer to the custom tag value obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfProperty_GetTimestamp()
int64_t OH_UdmfProperty_GetTimestamp (OH_UdmfProperty* pThis)
Description
Obtains the timestamp from an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
Returns
Returns the timestamp obtained.
See
OH_UdmfProperty_SetExtrasIntParam()
int OH_UdmfProperty_SetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int param )
Description
Sets the extra integer parameter for an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| key | Pointer to the key of the parameter to set. |
| param | Parameter value to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfProperty_SetExtrasStringParam()
int OH_UdmfProperty_SetExtrasStringParam (OH_UdmfProperty* pThis, const char* key, const char* param )
Description
Sets the extra string parameter for an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| key | Pointer to the key of the parameter to set. |
| param | Parameter value to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfProperty_SetShareOption()
int OH_UdmfProperty_SetShareOption (OH_UdmfProperty* pThis, Udmf_ShareOption option )
Description
Sets the share option for an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
| option | Udmf_ShareOption to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfProperty_SetTag()
int OH_UdmfProperty_SetTag (OH_UdmfProperty* pThis, const char* tag )
Description
Sets the tag value for an OH_UdmfProperty instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfProperty instance. |
| tag | Pointer to the tag value to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddAppItem()
int OH_UdmfRecord_AddAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )
Description
Adds data of the OH_UdsAppItem type to an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| appItem | Pointer to the OH_UdsAppItem instance to add. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddArrayBuffer()
int OH_UdmfRecord_AddArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )
Description
Adds a data record of the OH_UdsArrayBuffer type to an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| record | Pointer to the OH_UdmfRecord instance. |
| type | Pointer to the ArrayBuffer type ID, which must be unique. |
| buffer | Pointer to the OH_UdsArrayBuffer instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddFileUri()
int OH_UdmfRecord_AddFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )
Description
Adds a data record of the OH_UdsFileUri type to an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| fileUri | Pointer to the OH_UdsFileUri instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddGeneralEntry()
int OH_UdmfRecord_AddGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char* entry, unsigned int count )
Description
Adds customized uniform data to an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| typeId | Pointer to the data type ID. |
| entry | Pointer to the customized data to add. |
| count | Size of customized data to add. The data size cannot exceed 4 KB. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddHtml()
int OH_UdmfRecord_AddHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )
Description
Adds data of the OH_UdsHtml type to an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| html | Pointer to the OH_UdsHtml instance to add. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddHyperlink()
int OH_UdmfRecord_AddHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )
Description
Adds data of the hyperlink type OH_UdsHyperlink type to an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| hyperlink | Pointer to the OH_UdsHyperlink instance to add. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddPixelMap()
int OH_UdmfRecord_AddPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )
Description
Adds a data record of the OH_UdsPixelMap type to an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| pixelMap | Pointer to the OH_UdsPixelMap instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_AddPlainText()
int OH_UdmfRecord_AddPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )
Description
Adds data of the OH_UdsPlainText type to an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| plainText | Pointer to the OH_UdsPlainText instance to add. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_Create()
OH_UdmfRecord* OH_UdmfRecord_Create ()
Description
Creates an OH_UdmfRecord instance and a pointer to it. If this pointer is no longer required, use OH_UdmfRecord_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdmfRecord instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdmfRecord_Destroy()
void OH_UdmfRecord_Destroy (OH_UdmfRecord* pThis)
Description
Destroys an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance to destroy. |
See
OH_UdmfRecord_GetAppItem()
int OH_UdmfRecord_GetAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )
Description
Obtains OH_UdsAppItem data from an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| appItem | Pointer to the OH_UdsAppItem instance obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetArrayBuffer()
int OH_UdmfRecord_GetArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )
Description
Obtains the OH_UdsArrayBuffer data from an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| record | Pointer to the OH_UdmfRecord instance. |
| type | Pointer to the data type ID of the ArrayBuffer data to obtain. |
| buffer | Pointer to the OH_UdsArrayBuffer data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetFileUri()
int OH_UdmfRecord_GetFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )
Description
Obtains the OH_UdsFileUri data from an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| fileUri | Pointer to the OH_UdsFileUri data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetGeneralEntry()
int OH_UdmfRecord_GetGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char** entry, unsigned int* count )
Description
Obtains the data of the specified type in an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| typeId | Pointer to the data type ID. |
| entry | Double pointer to the data obtained. |
| count | Length of the data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetHtml()
int OH_UdmfRecord_GetHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )
Description
Obtains OH_UdsHtml data from an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| html | Pointer to the OH_UdsHtml data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetHyperlink()
int OH_UdmfRecord_GetHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )
Description
Obtains OH_UdsHyperlink data from an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| hyperlink | Pointer to the OH_UdsHyperlink data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetPixelMap()
int OH_UdmfRecord_GetPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )
Description
Obtains the OH_UdsPixelMap data from an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| pixelMap | Pointer to the OH_UdsPixelMap data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetPlainText()
int OH_UdmfRecord_GetPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )
Description
Obtains OH_UdsPlainText data from an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| plainText | Pointer to the OH_UdsPlainText data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecord_GetTypes()
char** OH_UdmfRecord_GetTypes (OH_UdmfRecord* pThis, unsigned int* count )
Description
Obtains all data types in an OH_UdmfRecord instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| count | Pointer to the number of data types obtained. |
Returns
Returns a list of data types obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdmfRecord_SetProvider()
int OH_UdmfRecord_SetProvider (OH_UdmfRecord* pThis, const char* const* types, unsigned int count, OH_UdmfRecordProvider* provider )
Description
Sets the OH_UdmfRecordProvider in an OH_UdmfRecord instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdmfRecord instance. |
| types | Pointer to the data types to be provided. |
| count | Number of the data types. |
| provider | Pointer to the OH_UdmfRecordProvider instance to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecordProvider_Create()
OH_UdmfRecordProvider* OH_UdmfRecordProvider_Create ()
Description
Creates an OH_UdmfRecordProvider instance and a pointer to it. If this pointer is no longer required, use OH_UdmfRecordProvider_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 13
Returns
Returns a pointer to the OH_UdmfRecordProvider instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdmfRecordProvider_Destroy()
int OH_UdmfRecordProvider_Destroy (OH_UdmfRecordProvider* provider)
Description
Destroys an OH_UdmfRecordProvider instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| provider | Pointer to the OH_UdmfRecordProvider instance to destroy. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdmfRecordProvider_SetData()
int OH_UdmfRecordProvider_SetData (OH_UdmfRecordProvider* provider, void* context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize )
Description
Sets a callback for an OH_UdmfRecordProvider instance to provide data.
Since: 13
Parameters
| Name | Description |
|---|---|
| provider | Pointer to the target OH_UdmfRecordProvider instance. |
| context | Pointer to the context, which is passed as the first parameter to OH_UdmfRecordProvider_GetData. |
| callback | Callback used to obtain data. For details, see OH_UdmfRecordProvider_GetData. |
| finalize | Optional callback used to release the context data when the OH_UdmfRecordProvider instance is destroyed. For details, see UdmfData_Finalize. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
UdmfData_Finalize Udmf_ErrCode
OH_UdsAppItem_Create()
OH_UdsAppItem* OH_UdsAppItem_Create ()
Description
Creates an OH_UdsAppItem instance and a pointer to it. If this pointer is no longer required, use OH_UdsAppItem_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdsAppItem data obtained; returns nullptr otherwise.
See
OH_UdsAppItem_Destroy()
void OH_UdsAppItem_Destroy (OH_UdsAppItem* pThis)
Description
Destroys an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance to destroy. |
See
OH_UdsAppItem_GetAbilityName()
const char* OH_UdsAppItem_GetAbilityName (OH_UdsAppItem* pThis)
Description
Obtains the ability name from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the ability name obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetBundleName()
const char* OH_UdsAppItem_GetBundleName (OH_UdsAppItem* pThis)
Description
Obtains the bundle name from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the bundle name obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetIconId()
const char* OH_UdsAppItem_GetIconId (OH_UdsAppItem* pThis)
Description
Obtains the application icon ID from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the application icon ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetId()
const char* OH_UdsAppItem_GetId (OH_UdsAppItem* pThis)
Description
Obtains the application ID from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the application ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetLabelId()
const char* OH_UdsAppItem_GetLabelId (OH_UdsAppItem* pThis)
Description
Obtains the application label ID from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the application label ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetName()
const char* OH_UdsAppItem_GetName (OH_UdsAppItem* pThis)
Description
Obtains the application name from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the application name obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_GetType()
const char* OH_UdsAppItem_GetType (OH_UdsAppItem* pThis)
Description
Obtains the type ID from an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsAppItem_SetAbilityName()
int OH_UdsAppItem_SetAbilityName (OH_UdsAppItem* pThis, const char* abilityName )
Description
Sets the ability name for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| abilityName | Pointer to the ability name to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsAppItem_SetBundleName()
int OH_UdsAppItem_SetBundleName (OH_UdsAppItem* pThis, const char* bundleName )
Description
Sets the bundle name for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| bundleName | Pointer to the bundle name to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsAppItem_SetIconId()
int OH_UdsAppItem_SetIconId (OH_UdsAppItem* pThis, const char* appIconId )
Description
Sets the application icon ID for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| appIconId | Pointer to the application icon ID to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsAppItem_SetId()
int OH_UdsAppItem_SetId (OH_UdsAppItem* pThis, const char* appId )
Description
Sets the application ID for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| appId | Pointer to the application ID to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsAppItem_SetLabelId()
int OH_UdsAppItem_SetLabelId (OH_UdsAppItem* pThis, const char* appLabelId )
Description
Sets the application label ID for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| appLabelId | Pointer to the application label ID to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsAppItem_SetName()
int OH_UdsAppItem_SetName (OH_UdsAppItem* pThis, const char* appName )
Description
Sets the application name for an OH_UdsAppItem instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsAppItem instance. |
| appName | Pointer to the application name to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsArrayBuffer_Create()
OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create ()
Description
Creates an OH_UdsArrayBuffer instance and a pointer to it. If this pointer is no longer required, use OH_UdsArrayBuffer_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 13
Returns
Returns a pointer to the OH_UdsArrayBuffer instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsArrayBuffer_Destroy()
int OH_UdsArrayBuffer_Destroy (OH_UdsArrayBuffer* buffer)
Description
Destroys an OH_UdsArrayBuffer instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| buffer | Pointer to the OH_UdsArrayBuffer instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsArrayBuffer_GetData()
int OH_UdsArrayBuffer_GetData (OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len )
Description
Obtains the custom ArrayBuffer data from an OH_UdsArrayBuffer instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| buffer | Pointer to the target OH_UdsArrayBuffer instance. |
| data | Double pointer to the ArrayBuffer data obtained. |
| len | Pointer to the length of the ArrayBuffer data obtained. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsArrayBuffer_SetData()
int OH_UdsArrayBuffer_SetData (OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len )
Description
Sets an OH_UdsArrayBuffer instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| buffer | Pointer to the target OH_UdsArrayBuffer instance. |
| data | Pointer to the ArrayBuffer data to set. |
| len | Length of the ArrayBuffer data to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsFileUri_Create()
OH_UdsFileUri* OH_UdsFileUri_Create ()
Description
Creates an OH_UdsFileUri instance and a pointer to it. If this pointer is no longer required, use OH_UdsFileUri_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 13
Returns
Returns a pointer to the OH_UdsFileUri instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsFileUri_Destroy()
void OH_UdsFileUri_Destroy (OH_UdsFileUri* pThis)
Description
Destroys an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsFileUri instance to destroy. |
See
OH_UdsFileUri_GetFileType()
const char* OH_UdsFileUri_GetFileType (OH_UdsFileUri* pThis)
Description
Obtains the file type from an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsFileUri instance. |
Returns
Returns a pointer to the file type obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsFileUri_GetFileUri()
const char* OH_UdsFileUri_GetFileUri (OH_UdsFileUri* pThis)
Description
Obtains the file URI from an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsFileUri instance. |
Returns
Returns a pointer to the file URI obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsFileUri_GetType()
const char* OH_UdsFileUri_GetType (OH_UdsFileUri* pThis)
Description
Obtains the type ID from an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsFileUri instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsFileUri_SetFileType()
int OH_UdsFileUri_SetFileType (OH_UdsFileUri* pThis, const char* fileType )
Description
Sets the file type for an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsFileUri instance. |
| fileType | Pointer to the file type to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsFileUri_SetFileUri()
int OH_UdsFileUri_SetFileUri (OH_UdsFileUri* pThis, const char* fileUri )
Description
Sets the URI information for an OH_UdsFileUri instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsFileUri instance. |
| fileUri | Pointer to the file URI to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsHtml_Create()
OH_UdsHtml* OH_UdsHtml_Create ()
Description
Creates an OH_UdsHtml instance and a pointer to it. If this pointer is no longer required, use OH_UdsHtml_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdsHtml instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsHtml_Destroy()
void OH_UdsHtml_Destroy (OH_UdsHtml* pThis)
Description
Destroys an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance to destroy. |
See
OH_UdsHtml_GetContent()
const char* OH_UdsHtml_GetContent (OH_UdsHtml* pThis)
Description
Obtains the HTML content from an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance. |
Returns
Returns a pointer to the HTML content obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHtml_GetPlainContent()
const char* OH_UdsHtml_GetPlainContent (OH_UdsHtml* pThis)
Description
Obtains the plaintext from an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance. |
Returns
Returns a pointer to the plaintext obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHtml_GetType()
const char* OH_UdsHtml_GetType (OH_UdsHtml* pThis)
Description
Obtains the type ID from an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHtml_SetContent()
int OH_UdsHtml_SetContent (OH_UdsHtml* pThis, const char* content )
Description
Sets the HTML content for an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance. |
| content | Pointer to the content in HTML format to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsHtml_SetPlainContent()
int OH_UdsHtml_SetPlainContent (OH_UdsHtml* pThis, const char* plainContent )
Description
Sets the plaintext for an OH_UdsHtml instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHtml instance. |
| plainContent | Pointer to the plain text content to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsHyperlink_Create()
OH_UdsHyperlink* OH_UdsHyperlink_Create ()
Description
Creates an OH_UdsHyperlink instance and a pointer to it. If this pointer is no longer required, use OH_UdsHyperlink_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdsHyperlink instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsHyperlink_Destroy()
void OH_UdsHyperlink_Destroy (OH_UdsHyperlink* pThis)
Description
Destroys an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance to destroy. |
See
OH_UdsHyperlink_GetDescription()
const char* OH_UdsHyperlink_GetDescription (OH_UdsHyperlink* pThis)
Description
Obtains the description from an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance. |
Returns
Returns a pointer to the description obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHyperlink_GetType()
const char* OH_UdsHyperlink_GetType (OH_UdsHyperlink* pThis)
Description
Obtains the type ID from an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHyperlink_GetUrl()
const char* OH_UdsHyperlink_GetUrl (OH_UdsHyperlink* pThis)
Description
Obtains the URL from an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance. |
Returns
Returns a pointer to the URL obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsHyperlink_SetDescription()
int OH_UdsHyperlink_SetDescription (OH_UdsHyperlink* pThis, const char* description )
Description
Sets the description for an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance. |
| description | Pointer to the description to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsHyperlink_SetUrl()
int OH_UdsHyperlink_SetUrl (OH_UdsHyperlink* pThis, const char* url )
Description
Sets the URL for an OH_UdsHyperlink instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsHyperlink instance. |
| url | Pointer to the URL to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsPixelMap_Create()
OH_UdsPixelMap* OH_UdsPixelMap_Create ()
Description
Creates an OH_UdsPixelMap instance and a pointer to it. If this pointer is no longer required, use OH_UdsPixelMap_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 13
Returns
Returns a pointer to the OH_UdsPixelMap instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsPixelMap_Destroy()
void OH_UdsPixelMap_Destroy (OH_UdsPixelMap* pThis)
Description
Destroys an OH_UdsPixelMap instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPixelMap instance to destroy. |
See
OH_UdsPixelMap_GetPixelMap()
void OH_UdsPixelMap_GetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )
Description
Obtains the pointer to the OH_PixelmapNative instance from an OH_UdsPixelMap instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsPixelMap instance. |
| pixelmapNative | Pointer to the OH_PixelmapNative instance obtained. |
See
OH_PixelmapNative
OH_UdsPixelMap_GetType()
const char* OH_UdsPixelMap_GetType (OH_UdsPixelMap* pThis)
Description
Obtains the type ID from an OH_UdsPixelMap instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsPixelMap instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsPixelMap_SetPixelMap()
int OH_UdsPixelMap_SetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )
Description
Sets the pixel map content for an OH_UdsPixelMap instance.
Since: 13
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the target OH_UdsPixelMap instance. |
| pixelmapNative | Pointer to the OH_PixelmapNative instance. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_PixelmapNative
OH_UdsPlainText_Create()
OH_UdsPlainText* OH_UdsPlainText_Create ()
Description
Creates an OH_UdsPlainText instance and a pointer to it. If this pointer is no longer required, use OH_UdsPlainText_Destroy to destroy it. Otherwise, memory leaks may occur.
Since: 12
Returns
Returns a pointer to the OH_UdsPlainText instance created if the operation is successful; returns nullptr otherwise.
See
OH_UdsPlainText_Destroy()
void OH_UdsPlainText_Destroy (OH_UdsPlainText* pThis)
Description
Destroys an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance to destroy. |
See
OH_UdsPlainText_GetAbstract()
const char* OH_UdsPlainText_GetAbstract (OH_UdsPlainText* pThis)
Description
Obtains the abstract from an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance. |
Returns
Returns a pointer to the abstract information obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsPlainText_GetContent()
const char* OH_UdsPlainText_GetContent (OH_UdsPlainText* pThis)
Description
Obtains the plaintext from an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance. |
Returns
Returns a pointer to the plaintext obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsPlainText_GetType()
const char* OH_UdsPlainText_GetType (OH_UdsPlainText* pThis)
Description
Obtains the type ID from an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_UdsPlainText_SetAbstract()
int OH_UdsPlainText_SetAbstract (OH_UdsPlainText* pThis, const char* abstract )
Description
Sets the abstract for an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance. |
| abstract | Pointer to the abstract to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_UdsPlainText_SetContent()
int OH_UdsPlainText_SetContent (OH_UdsPlainText* pThis, const char* content )
Description
Sets the plaintext content for an OH_UdsPlainText instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_UdsPlainText instance. |
| content | Pointer to the plaintext content to set. |
Returns
Returns a Udmf_ErrCode.
Returns UDMF_E_OK if the operation is successful.
Returns UDMF_E_INVALID_PARAM if an invalid parameter is passed in.
See
OH_Utd_BelongsTo()
bool OH_Utd_BelongsTo (const char* srcTypeId, const char* destTypeId )
Description
Checks whether a UTD belongs to the target UTD.
Since: 12
Parameters
| Name | Description |
|---|---|
| srcTypeId | Pointer to the UTD to check. |
| destTypeId | Pointer to the target UTD. |
Returns
Returns true if the UTD belongs to the target UTD; returns false otherwise.
OH_Utd_Create()
OH_Utd* OH_Utd_Create (const char* typeId)
Description
Creates an OH_Utd instance and a pointer to it.
Since: 12
Parameters
| Name | Description |
|---|---|
| typeId | Pointer to the type ID of the instance to create. |
Returns
Returns a pointer to the OH_Utd instance created if the operation is successful; returns nullptr otherwise. If this pointer is no longer required, use OH_Utd_Destroy to destroy it. Otherwise, memory leaks may occur.
See
OH_Utd_Destroy()
void OH_Utd_Destroy (OH_Utd* pThis)
Description
Destroys an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance to destroy. |
See
OH_Utd_DestroyStringList()
void OH_Utd_DestroyStringList (const char** list, unsigned int count )
Description
Destroys a UTD list.
Since: 12
Parameters
| Name | Description |
|---|---|
| list | Double pointer to the UTD list to destroy. |
| count | Length of the UTD list. |
OH_Utd_Equals()
bool OH_Utd_Equals (OH_Utd* utd1, OH_Utd* utd2 )
Description
Checks whether two UTDs are the same.
Since: 12
Parameters
| Name | Description |
|---|---|
| desc1 | Pointer to one OH_Utd instance to compare. |
| desc2 | Pointer to the other OH_Utd instance to compare. |
Returns
Returns true if the two instances are the same; returns false otherwise.
OH_Utd_GetBelongingToTypes()
const char** OH_Utd_GetBelongingToTypes (OH_Utd* pThis, unsigned int* count )
Description
Obtains the relationships between the data in an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
| count | Pointer to the number of data types obtained. |
Returns
Returns a pointer to the relationship information obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetDescription()
const char* OH_Utd_GetDescription (OH_Utd* pThis)
Description
Obtains the description from an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
Returns
Returns a pointer to the description obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetFilenameExtensions()
const char** OH_Utd_GetFilenameExtensions (OH_Utd* pThis, unsigned int* count )
Description
Obtains the file name extensions associated with an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
| count | Pointer to the number of file name extensions obtained. |
Returns
Returns a pointer to the file name extensions obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetIconFile()
const char* OH_Utd_GetIconFile (OH_Utd* pThis)
Description
Obtains the path of the default icon file from an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
Returns
Returns a pointer to the path of the default icon file obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetMimeTypes()
const char** OH_Utd_GetMimeTypes (OH_Utd* pThis, unsigned int* count )
Description
Obtains the MIME types associated with an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
| count | Pointer to the number of MIME types obtained. |
Returns
Returns a pointer to the MIME types obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetReferenceUrl()
const char* OH_Utd_GetReferenceUrl (OH_Utd* pThis)
Description
Obtains the URL from an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
Returns
Returns a pointer to the URL obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetTypeId()
const char* OH_Utd_GetTypeId (OH_Utd* pThis)
Description
Obtains the type ID from an OH_Utd instance.
Since: 12
Parameters
| Name | Description |
|---|---|
| pThis | Pointer to the OH_Utd instance. |
Returns
Returns a pointer to the type ID obtained if the operation is successful; returns nullptr otherwise.
See
OH_Utd_GetTypesByFilenameExtension()
const char** OH_Utd_GetTypesByFilenameExtension (const char* extension, unsigned int* count )
Description
Obtains the uniform data types based on the file name extensions.
Since: 12
Parameters
| Name | Description |
|---|---|
| extension | Pointer to the file name extensions. |
| count | Pointer to the number of data types obtained. |
Returns
Returns a pointer to the uniform data types obtained. If it is no longer required, use OH_Utd_DestroyStringList to destroy it. Otherwise, memory leakage occurs.
OH_Utd_GetTypesByMimeType()
const char** OH_Utd_GetTypesByMimeType (const char* mimeType, unsigned int* count )
Description
Obtains the uniform data types based on the MIME types.
Since: 12
Parameters
| Name | Description |
|---|---|
| mimeType | Pointer to the MIME types. |
| count | Pointer to the number of data types obtained. |
Returns
Returns a pointer to the uniform data types obtained. If it is no longer required, use OH_Utd_DestroyStringList to destroy it. Otherwise, memory leakage occurs.
OH_Utd_IsHigher()
bool OH_Utd_IsHigher (const char* srcTypeId, const char* destTypeId )
Description
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.
Since: 12
Parameters
| Name | Description |
|---|---|
| srcTypeId | Pointer to the UTD to check. |
| destTypeId | Pointer to the target UTD. |
Returns
Returns true if the UTD is a higher-level type of the target UTD; returns false otherwise.
OH_Utd_IsLower()
bool OH_Utd_IsLower (const char* srcTypeId, const char* destTypeId )
Description
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.
Since: 12
Parameters
| Name | Description |
|---|---|
| srcTypeId | Pointer to the UTD to check. |
| destTypeId | Pointer to the target UTD. |
Returns
Returns true if the UTD is a lower-level type of the target UTD; returns false otherwise.