uds.h
Overview
Defines the APIs and structs related to the uniform data structs.
File to include: <database/udmf/uds.h>
Library: libudmf.so
System capability: SystemCapability.DistributedDataManager.UDMF.Core
Since: 12
Related module: UDMF
Summary
Types
| Name | Description |
|---|---|
| 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 uniform data of the file URI type. |
| typedef struct OH_UdsPixelMap OH_UdsPixelMap | Defines a struct for the uniform data of the pixel map type. |
| typedef struct OH_UdsArrayBuffer OH_UdsArrayBuffer | Defines a struct for the uniform data of the ArrayBuffer type. |
| typedef struct OH_UdsContentForm OH_UdsContentForm | Defines a struct for the uniform data of the content widget type. |
Functions
| Name | Description |
|---|---|
| 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 content 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) | Obtain 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 data for an OH_UdsArrayBuffer instance. |
| int OH_UdsArrayBuffer_GetData (OH_UdsArrayBuffer *buffer, unsigned char **data, unsigned int *len) | Obtains the custom ArrayBuffer from an OH_UdsArrayBuffer 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. |