• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# uds.h
2
3## Overview
4
5Defines the APIs and structs related to the uniform data structs.
6
7**File to include**: <database/udmf/uds.h>
8
9**Library**: libudmf.so
10
11**System capability**: SystemCapability.DistributedDataManager.UDMF.Core
12
13**Since**: 12
14
15**Related module**: [UDMF](capi-udmf.md)
16
17## Summary
18
19### Structs
20
21| Name                                          | typedef Keyword    | Description                                  |
22| ---------------------------------------------- | ----------------- | -------------------------------------- |
23| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)     | OH_UdsPlainText   | Defines a struct for the unified data of the plaintext type.    |
24| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)     | OH_UdsHyperlink   | Defines a struct for the unified data of the hyperlink type.        |
25| [OH_UdsHtml](capi-udmf-oh-udshtml.md)               | OH_UdsHtml        | Defines a struct for the unified data of the Hypertext Markup Language (HTML) type.|
26| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)         | OH_UdsAppItem     | Defines a struct for the unified data of the home screen icon type.      |
27| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)         | OH_UdsFileUri     | Defines a struct for the unified data of the file URI type.       |
28| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)       | OH_UdsPixelMap    | Defines a struct for the unified data of the pixel map type.      |
29| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) | OH_UdsArrayBuffer | Defines a struct for the unified data of the ArrayBuffer type.   |
30| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) | OH_UdsContentForm | Defines a struct for the unified data of the content card type.      |
31
32### Functions
33
34| Name                                                        | Description                                                        |
35| ------------------------------------------------------------ | ------------------------------------------------------------ |
36| [OH_UdsPlainText* OH_UdsPlainText_Create()](#oh_udsplaintext_create) | Creates an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPlainText_Destroy](capi-uds-h.md#oh_udsplaintext_destroy) to destroy it. Otherwise, memory leaks may occur.|
37| [void OH_UdsPlainText_Destroy(OH_UdsPlainText* pThis)](#oh_udsplaintext_destroy) | Destroys an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
38| [const char* OH_UdsPlainText_GetType(OH_UdsPlainText* pThis)](#oh_udsplaintext_gettype) | Obtains the type ID from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
39| [const char* OH_UdsPlainText_GetContent(OH_UdsPlainText* pThis)](#oh_udsplaintext_getcontent) | Obtains the plaintext from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
40| [const char* OH_UdsPlainText_GetAbstract(OH_UdsPlainText* pThis)](#oh_udsplaintext_getabstract) | Obtains the abstract from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
41| [int OH_UdsPlainText_SetContent(OH_UdsPlainText* pThis, const char* content)](#oh_udsplaintext_setcontent) | Sets the plaintext content for an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
42| [int OH_UdsPlainText_SetAbstract(OH_UdsPlainText* pThis, const char* abstract)](#oh_udsplaintext_setabstract) | Sets the abstract for an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
43| [OH_UdsHyperlink* OH_UdsHyperlink_Create()](#oh_udshyperlink_create) | Creates an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHyperlink_Destroy](capi-uds-h.md#oh_udshyperlink_destroy) to destroy it. Otherwise, memory leaks may occur.|
44| [void OH_UdsHyperlink_Destroy(OH_UdsHyperlink* pThis)](#oh_udshyperlink_destroy) | Destroys an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
45| [const char* OH_UdsHyperlink_GetType(OH_UdsHyperlink* pThis)](#oh_udshyperlink_gettype) | Obtains the type ID from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
46| [const char* OH_UdsHyperlink_GetUrl(OH_UdsHyperlink* pThis)](#oh_udshyperlink_geturl) | Obtains the URL from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
47| [const char* OH_UdsHyperlink_GetDescription(OH_UdsHyperlink* pThis)](#oh_udshyperlink_getdescription) | Obtains the description from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
48| [int OH_UdsHyperlink_SetUrl(OH_UdsHyperlink* pThis, const char* url)](#oh_udshyperlink_seturl) | Sets the URL for an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
49| [int OH_UdsHyperlink_SetDescription(OH_UdsHyperlink* pThis, const char* description)](#oh_udshyperlink_setdescription) | Sets the description for an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
50| [OH_UdsHtml* OH_UdsHtml_Create()](#oh_udshtml_create)        | Creates an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHtml_Destroy](capi-uds-h.md#oh_udshtml_destroy) to destroy it. Otherwise, memory leaks may occur.|
51| [void OH_UdsHtml_Destroy(OH_UdsHtml* pThis)](#oh_udshtml_destroy) | Destroys an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
52| [const char* OH_UdsHtml_GetType(OH_UdsHtml* pThis)](#oh_udshtml_gettype) | Obtains the type ID from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
53| [const char* OH_UdsHtml_GetContent(OH_UdsHtml* pThis)](#oh_udshtml_getcontent) | Obtains the HTML content from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
54| [const char* OH_UdsHtml_GetPlainContent(OH_UdsHtml* pThis)](#oh_udshtml_getplaincontent) | Obtains the plaintext content from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
55| [int OH_UdsHtml_SetContent(OH_UdsHtml* pThis, const char* content)](#oh_udshtml_setcontent) | Sets the HTML content for an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
56| [int OH_UdsHtml_SetPlainContent(OH_UdsHtml* pThis, const char* plainContent)](#oh_udshtml_setplaincontent) | Sets the plaintext content for an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
57| [OH_UdsAppItem* OH_UdsAppItem_Create()](#oh_udsappitem_create) | Creates an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsAppItem_Destroy](capi-uds-h.md#oh_udsappitem_destroy) to destroy it. Otherwise, memory leaks may occur.|
58| [void OH_UdsAppItem_Destroy(OH_UdsAppItem* pThis)](#oh_udsappitem_destroy) | Destroys an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
59| [const char* OH_UdsAppItem_GetType(OH_UdsAppItem* pThis)](#oh_udsappitem_gettype) | Obtains the type ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
60| [const char* OH_UdsAppItem_GetId(OH_UdsAppItem* pThis)](#oh_udsappitem_getid) | Obtains the application ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
61| [const char* OH_UdsAppItem_GetName(OH_UdsAppItem* pThis)](#oh_udsappitem_getname) | Obtains the application name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
62| [const char* OH_UdsAppItem_GetIconId(OH_UdsAppItem* pThis)](#oh_udsappitem_geticonid) | Obtains the image ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
63| [const char* OH_UdsAppItem_GetLabelId(OH_UdsAppItem* pThis)](#oh_udsappitem_getlabelid) | Obtains the label ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
64| [const char* OH_UdsAppItem_GetBundleName(OH_UdsAppItem* pThis)](#oh_udsappitem_getbundlename) | Obtains the bundle name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
65| [const char* OH_UdsAppItem_GetAbilityName(OH_UdsAppItem* pThis)](#oh_udsappitem_getabilityname) | Obtains the ability name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
66| [int OH_UdsAppItem_SetId(OH_UdsAppItem* pThis, const char* appId)](#oh_udsappitem_setid) | Sets the application ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
67| [int OH_UdsAppItem_SetName(OH_UdsAppItem* pThis, const char* appName)](#oh_udsappitem_setname) | Sets the application name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
68| [int OH_UdsAppItem_SetIconId(OH_UdsAppItem* pThis, const char* appIconId)](#oh_udsappitem_seticonid) | Sets the image ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
69| [int OH_UdsAppItem_SetLabelId(OH_UdsAppItem* pThis, const char* appLabelId)](#oh_udsappitem_setlabelid) | Sets the label ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
70| [int OH_UdsAppItem_SetBundleName(OH_UdsAppItem* pThis, const char* bundleName)](#oh_udsappitem_setbundlename) | Sets the bundle name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
71| [int OH_UdsAppItem_SetAbilityName(OH_UdsAppItem* pThis, const char* abilityName)](#oh_udsappitem_setabilityname) | Sets the ability name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
72| [OH_UdsFileUri* OH_UdsFileUri_Create()](#oh_udsfileuri_create) | Creates an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsFileUri_Destroy](capi-uds-h.md#oh_udsfileuri_destroy) to destroy it. Otherwise, memory leaks may occur.|
73| [void OH_UdsFileUri_Destroy(OH_UdsFileUri* pThis)](#oh_udsfileuri_destroy) | Destroys an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
74| [const char* OH_UdsFileUri_GetType(OH_UdsFileUri* pThis)](#oh_udsfileuri_gettype) | Obtains the type ID from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
75| [const char* OH_UdsFileUri_GetFileUri(OH_UdsFileUri* pThis)](#oh_udsfileuri_getfileuri) | Obtains the file URI from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
76| [const char* OH_UdsFileUri_GetFileType(OH_UdsFileUri* pThis)](#oh_udsfileuri_getfiletype) | Obtains the file type from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
77| [int OH_UdsFileUri_SetFileUri(OH_UdsFileUri* pThis, const char* fileUri)](#oh_udsfileuri_setfileuri) | Sets the URI information for an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
78| [int OH_UdsFileUri_SetFileType(OH_UdsFileUri* pThis, const char* fileType)](#oh_udsfileuri_setfiletype) | Sets the file type for an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
79| [OH_UdsPixelMap* OH_UdsPixelMap_Create()](#oh_udspixelmap_create) | Creates an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPixelMap_Destroy](capi-uds-h.md#oh_udspixelmap_destroy) to destroy it. Otherwise, memory leaks may occur.|
80| [void OH_UdsPixelMap_Destroy(OH_UdsPixelMap* pThis)](#oh_udspixelmap_destroy) | Destroys an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
81| [const char* OH_UdsPixelMap_GetType(OH_UdsPixelMap* pThis)](#oh_udspixelmap_gettype) | Obtains the type ID from an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
82| [void OH_UdsPixelMap_GetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)](#oh_udspixelmap_getpixelmap) | Obtains the pointer to the [OH_PixelmapNative](../apis-image-kit/capi-pixelmap-native-h.md#oh_pixelmapnative_antialiasinglevel) instance from an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
83| [int OH_UdsPixelMap_SetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)](#oh_udspixelmap_setpixelmap) | Sets the pixel image content for an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
84| [OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create()](#oh_udsarraybuffer_create) | Creates an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsArrayBuffer_Destroy](capi-uds-h.md#oh_udsarraybuffer_destroy) to destroy it. Otherwise, memory leaks may occur.|
85| [int OH_UdsArrayBuffer_Destroy(OH_UdsArrayBuffer* buffer)](#oh_udsarraybuffer_destroy) | Destroys an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
86| [int OH_UdsArrayBuffer_SetData(OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len)](#oh_udsarraybuffer_setdata) | Sets the data content for an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
87| [int OH_UdsArrayBuffer_GetData(OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len)](#oh_udsarraybuffer_getdata) | Obtains the custom ArrayBuffer data from an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
88| [OH_UdsContentForm* OH_UdsContentForm_Create()](#oh_udscontentform_create) | Creates an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance and a pointer to it.|
89| [void OH_UdsContentForm_Destroy(OH_UdsContentForm* pThis)](#oh_udscontentform_destroy) | Destroys an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
90| [const char* OH_UdsContentForm_GetType(OH_UdsContentForm* pThis)](#oh_udscontentform_gettype) | Obtains the type ID from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
91| [int OH_UdsContentForm_GetThumbData(OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len)](#oh_udscontentform_getthumbdata) | Obtains the image data from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
92| [const char* OH_UdsContentForm_GetDescription(OH_UdsContentForm* pThis)](#oh_udscontentform_getdescription) | Obtains the description from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
93| [const char* OH_UdsContentForm_GetTitle(OH_UdsContentForm* pThis)](#oh_udscontentform_gettitle) | Obtains the title from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
94| [int OH_UdsContentForm_GetAppIcon(OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len)](#oh_udscontentform_getappicon) | Obtains the application icon data from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
95| [const char* OH_UdsContentForm_GetAppName(OH_UdsContentForm* pThis)](#oh_udscontentform_getappname) | Obtains the application name from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
96| [const char* OH_UdsContentForm_GetLinkUri(OH_UdsContentForm* pThis)](#oh_udscontentform_getlinkuri) | Obtains the hyperlink from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
97| [int OH_UdsContentForm_SetThumbData(OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len)](#oh_udscontentform_setthumbdata) | Sets the image data for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
98| [int OH_UdsContentForm_SetDescription(OH_UdsContentForm* pThis, const char* description)](#oh_udscontentform_setdescription) | Sets the description for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
99| [int OH_UdsContentForm_SetTitle(OH_UdsContentForm* pThis, const char* title)](#oh_udscontentform_settitle) | Sets the title for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
100| [int OH_UdsContentForm_SetAppIcon(OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len)](#oh_udscontentform_setappicon) | Sets the application icon data for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
101| [int OH_UdsContentForm_SetAppName(OH_UdsContentForm* pThis, const char* appName)](#oh_udscontentform_setappname) | Sets the application name for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
102| [int OH_UdsContentForm_SetLinkUri(OH_UdsContentForm* pThis, const char* linkUri)](#oh_udscontentform_setlinkuri) | Sets the hyperlink for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
103
104## Function Description
105
106### OH_UdsPlainText_Create()
107
108```
109OH_UdsPlainText* OH_UdsPlainText_Create()
110```
111
112**Description**
113
114Creates an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPlainText_Destroy](capi-uds-h.md#oh_udsplaintext_destroy) to destroy it. Otherwise, memory leaks may occur.
115
116**Since**: 12
117
118**Returns**
119
120| Type                                       | Description                                                        |
121| ------------------------------------------- | ------------------------------------------------------------ |
122| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* | Returns a pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance created if the operation is successful; returns **nullptr** otherwise.|
123
124### OH_UdsPlainText_Destroy()
125
126```
127void OH_UdsPlainText_Destroy(OH_UdsPlainText* pThis)
128```
129
130**Description**
131
132Destroys an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
133
134**Since**: 12
135
136
137**Parameters**
138
139| Name                                           | Description                                                        |
140| ------------------------------------------------- | ------------------------------------------------------------ |
141| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
142
143### OH_UdsPlainText_GetType()
144
145```
146const char* OH_UdsPlainText_GetType(OH_UdsPlainText* pThis)
147```
148
149**Description**
150
151Obtains the type ID from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
152
153**Since**: 12
154
155
156**Parameters**
157
158| Name                                           | Description                                                        |
159| ------------------------------------------------- | ------------------------------------------------------------ |
160| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
161
162**Returns**
163
164| Type       | Description                                                   |
165| ----------- | ------------------------------------------------------- |
166| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
167
168### OH_UdsPlainText_GetContent()
169
170```
171const char* OH_UdsPlainText_GetContent(OH_UdsPlainText* pThis)
172```
173
174**Description**
175
176Obtains the plaintext from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
177
178**Since**: 12
179
180
181**Parameters**
182
183| Name                                           | Description                                                        |
184| ------------------------------------------------- | ------------------------------------------------------------ |
185| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
186
187**Returns**
188
189| Type       | Description                                                        |
190| ----------- | ------------------------------------------------------------ |
191| const char* | Returns a pointer to the plaintext obtained if the operation is successful; returns **nullptr** otherwise.|
192
193### OH_UdsPlainText_GetAbstract()
194
195```
196const char* OH_UdsPlainText_GetAbstract(OH_UdsPlainText* pThis)
197```
198
199**Description**
200
201Obtains the abstract from an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
202
203**Since**: 12
204
205
206**Parameters**
207
208| Name                                           | Description                                                        |
209| ------------------------------------------------- | ------------------------------------------------------------ |
210| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
211
212**Returns**
213
214| Type       | Description                                                        |
215| ----------- | ------------------------------------------------------------ |
216| const char* | Returns a pointer to the abstract obtained if the operation is successful; returns **nullptr** otherwise.|
217
218OH_UdsPlainText
219
220### OH_UdsPlainText_SetContent()
221
222```
223int OH_UdsPlainText_SetContent(OH_UdsPlainText* pThis, const char* content)
224```
225
226**Description**
227
228Sets the plaintext content for an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
229
230**Since**: 12
231
232
233**Parameters**
234
235| Name                                           | Description                                                        |
236| ------------------------------------------------- | ------------------------------------------------------------ |
237| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
238| const char* content                               | Pointer to the plain text content to set.                                        |
239
240**Returns**
241
242| Type| Description                                                        |
243| ---- | ------------------------------------------------------------ |
244| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
245
246### OH_UdsPlainText_SetAbstract()
247
248```
249int OH_UdsPlainText_SetAbstract(OH_UdsPlainText* pThis, const char* abstract)
250```
251
252**Description**
253
254Sets the abstract for an [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.
255
256**Since**: 12
257
258
259**Parameters**
260
261| Name                                           | Description                                                        |
262| ------------------------------------------------- | ------------------------------------------------------------ |
263| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* pThis | Pointer to the [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md) instance.|
264| const char* abstract                              | Pointer to the abstract to set.                                        |
265
266**Returns**
267
268| Type| Description                                                        |
269| ---- | ------------------------------------------------------------ |
270| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
271
272### OH_UdsHyperlink_Create()
273
274```
275OH_UdsHyperlink* OH_UdsHyperlink_Create()
276```
277
278**Description**
279
280Creates an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHyperlink_Destroy](capi-uds-h.md#oh_udshyperlink_destroy) to destroy it. Otherwise, memory leaks may occur.
281
282**Since**: 12
283
284**Returns**
285
286| Type            | Description                                                        |
287| ---------------- | ------------------------------------------------------------ |
288| OH_UdsHyperlink* | Returns a pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance created if the operation is successful; returns **nullptr** otherwise.|
289
290### OH_UdsHyperlink_Destroy()
291
292```
293void OH_UdsHyperlink_Destroy(OH_UdsHyperlink* pThis)
294```
295
296**Description**
297
298Destroys an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
299
300**Since**: 12
301
302
303**Parameters**
304
305| Name                                           | Description                                                        |
306| ------------------------------------------------- | ------------------------------------------------------------ |
307| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
308
309### OH_UdsHyperlink_GetType()
310
311```
312const char* OH_UdsHyperlink_GetType(OH_UdsHyperlink* pThis)
313```
314
315**Description**
316
317Obtains the type ID from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
318
319**Since**: 12
320
321
322**Parameters**
323
324| Name                                           | Description                                                        |
325| ------------------------------------------------- | ------------------------------------------------------------ |
326| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
327
328**Returns**
329
330| Type       | Description                                                   |
331| ----------- | ------------------------------------------------------- |
332| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
333
334### OH_UdsHyperlink_GetUrl()
335
336```
337const char* OH_UdsHyperlink_GetUrl(OH_UdsHyperlink* pThis)
338```
339
340**Description**
341
342Obtains the URL from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
343
344**Since**: 12
345
346
347**Parameters**
348
349| Name                                           | Description                                                        |
350| ------------------------------------------------- | ------------------------------------------------------------ |
351| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
352
353**Returns**
354
355| Type       | Description                                                    |
356| ----------- | -------------------------------------------------------- |
357| const char* | Returns a pointer to the URL obtained if the operation is successful; returns **nullptr** otherwise.|
358
359### OH_UdsHyperlink_GetDescription()
360
361```
362const char* OH_UdsHyperlink_GetDescription(OH_UdsHyperlink* pThis)
363```
364
365**Description**
366
367Obtains the description from an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
368
369**Since**: 12
370
371
372**Parameters**
373
374| Name                                           | Description                                                        |
375| ------------------------------------------------- | ------------------------------------------------------------ |
376| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
377
378**Returns**
379
380| Type       | Description                                                     |
381| ----------- | --------------------------------------------------------- |
382| const char* | Returns a pointer to the description obtained if the operation is successful; returns **nullptr** otherwise.|
383
384### OH_UdsHyperlink_SetUrl()
385
386```
387int OH_UdsHyperlink_SetUrl(OH_UdsHyperlink* pThis, const char* url)
388```
389
390**Description**
391
392Sets the URL for an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
393
394**Since**: 12
395
396
397**Parameters**
398
399| Name                                           | Description                                                        |
400| ------------------------------------------------- | ------------------------------------------------------------ |
401| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
402| const char* url                                   | Pointer to the URL to set.                                               |
403
404**Returns**
405
406| Type| Description                                                        |
407| ---- | ------------------------------------------------------------ |
408| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
409
410### OH_UdsHyperlink_SetDescription()
411
412```
413int OH_UdsHyperlink_SetDescription(OH_UdsHyperlink* pThis, const char* description)
414```
415
416**Description**
417
418Sets the description for an [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.
419
420**Since**: 12
421
422
423**Parameters**
424
425| Name                                           | Description                                                        |
426| ------------------------------------------------- | ------------------------------------------------------------ |
427| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* pThis | Pointer to the [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md) instance.|
428| const char* description                           | Pointer to the description to set.                                              |
429
430**Returns**
431
432| Type| Description                                                        |
433| ---- | ------------------------------------------------------------ |
434| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
435
436### OH_UdsHtml_Create()
437
438```
439OH_UdsHtml* OH_UdsHtml_Create()
440```
441
442**Description**
443
444Creates an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsHtml_Destroy](capi-uds-h.md#oh_udshtml_destroy) to destroy it. Otherwise, memory leaks may occur.
445
446**Since**: 12
447
448**Returns**
449
450| Type                             | Description                                                        |
451| --------------------------------- | ------------------------------------------------------------ |
452| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* | Returns a pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance created if the operation is successful; returns **nullptr** otherwise.|
453
454### OH_UdsHtml_Destroy()
455
456```
457void OH_UdsHtml_Destroy(OH_UdsHtml* pThis)
458```
459
460**Description**
461
462Destroys an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
463
464**Since**: 12
465
466
467**Parameters**
468
469| Name                                 | Description                                                        |
470| --------------------------------------- | ------------------------------------------------------------ |
471| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
472
473### OH_UdsHtml_GetType()
474
475```
476const char* OH_UdsHtml_GetType(OH_UdsHtml* pThis)
477```
478
479**Description**
480
481Obtains the type ID from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
482
483**Since**: 12
484
485
486**Parameters**
487
488| Name                                 | Description                                                        |
489| --------------------------------------- | ------------------------------------------------------------ |
490| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
491
492**Returns**
493
494| Type       | Description                                                   |
495| ----------- | ------------------------------------------------------- |
496| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
497
498### OH_UdsHtml_GetContent()
499
500```
501const char* OH_UdsHtml_GetContent(OH_UdsHtml* pThis)
502```
503
504**Description**
505
506Obtains the HTML content from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
507
508**Since**: 12
509
510
511**Parameters**
512
513| Name                                 | Description                                                        |
514| --------------------------------------- | ------------------------------------------------------------ |
515| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
516
517**Returns**
518
519| Type       | Description                                                        |
520| ----------- | ------------------------------------------------------------ |
521| const char* | Returns a pointer to the HTML content obtained if the operation is successful; returns **nullptr** otherwise.|
522
523### OH_UdsHtml_GetPlainContent()
524
525```
526const char* OH_UdsHtml_GetPlainContent(OH_UdsHtml* pThis)
527```
528
529**Description**
530
531Obtains the plaintext content from an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
532
533**Since**: 12
534
535
536**Parameters**
537
538| Name                                 | Description                                                        |
539| --------------------------------------- | ------------------------------------------------------------ |
540| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
541
542**Returns**
543
544| Type       | Description                                                       |
545| ----------- | ----------------------------------------------------------- |
546| const char* | Returns a pointer to the plaintext obtained if the operation is successful; returns **nullptr** otherwise.|
547
548### OH_UdsHtml_SetContent()
549
550```
551int OH_UdsHtml_SetContent(OH_UdsHtml* pThis, const char* content)
552```
553
554**Description**
555
556Sets the HTML content for an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
557
558**Since**: 12
559
560
561**Parameters**
562
563| Name                                 | Description                                                        |
564| --------------------------------------- | ------------------------------------------------------------ |
565| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
566| const char* content                     | Pointer to the content in HTML format to set.                                      |
567
568**Returns**
569
570| Type| Description                                                        |
571| ---- | ------------------------------------------------------------ |
572| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
573
574### OH_UdsHtml_SetPlainContent()
575
576```
577int OH_UdsHtml_SetPlainContent(OH_UdsHtml* pThis, const char* plainContent)
578```
579
580**Description**
581
582Sets the plaintext content for an [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.
583
584**Since**: 12
585
586
587**Parameters**
588
589| Name                                 | Description                                                        |
590| --------------------------------------- | ------------------------------------------------------------ |
591| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* pThis | Pointer to the [OH_UdsHtml](capi-udmf-oh-udshtml.md) instance.|
592| const char* plainContent                | Pointer to the plain text content to set.                                        |
593
594**Returns**
595
596| Type| Description                                                        |
597| ---- | ------------------------------------------------------------ |
598| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
599
600### OH_UdsAppItem_Create()
601
602```
603OH_UdsAppItem* OH_UdsAppItem_Create()
604```
605
606**Description**
607
608Creates an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsAppItem_Destroy](capi-uds-h.md#oh_udsappitem_destroy) to destroy it. Otherwise, memory leaks may occur.
609
610**Since**: 12
611
612**Returns**
613
614| Type                                   | Description                                                        |
615| --------------------------------------- | ------------------------------------------------------------ |
616| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* | Returns a pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance created if the operation is successful; returns **nullptr** otherwise.|
617
618### OH_UdsAppItem_Destroy()
619
620```
621void OH_UdsAppItem_Destroy(OH_UdsAppItem* pThis)
622```
623
624**Description**
625
626Destroys an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
627
628**Since**: 12
629
630
631**Parameters**
632
633| Name                                       | Description                                                        |
634| --------------------------------------------- | ------------------------------------------------------------ |
635| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
636
637### OH_UdsAppItem_GetType()
638
639```
640const char* OH_UdsAppItem_GetType(OH_UdsAppItem* pThis)
641```
642
643**Description**
644
645Obtains the type ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
646
647**Since**: 12
648
649
650**Parameters**
651
652| Name                                       | Description                                                        |
653| --------------------------------------------- | ------------------------------------------------------------ |
654| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
655
656**Returns**
657
658| Type       | Description                                                   |
659| ----------- | ------------------------------------------------------- |
660| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
661
662### OH_UdsAppItem_GetId()
663
664```
665const char* OH_UdsAppItem_GetId(OH_UdsAppItem* pThis)
666```
667
668**Description**
669
670Obtains the application ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
671
672**Since**: 12
673
674
675**Parameters**
676
677| Name                                       | Description                                                        |
678| --------------------------------------------- | ------------------------------------------------------------ |
679| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
680
681**Returns**
682
683| Type       | Description                                                   |
684| ----------- | ------------------------------------------------------- |
685| const char* | Returns a pointer to the application ID obtained if the operation is successful; returns **nullptr** otherwise.|
686
687### OH_UdsAppItem_GetName()
688
689```
690const char* OH_UdsAppItem_GetName(OH_UdsAppItem* pThis)
691```
692
693**Description**
694
695Obtains the application name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
696
697**Since**: 12
698
699
700**Parameters**
701
702| Name                                       | Description                                                        |
703| --------------------------------------------- | ------------------------------------------------------------ |
704| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
705
706**Returns**
707
708| Type       | Description                                                     |
709| ----------- | --------------------------------------------------------- |
710| const char* | Returns a pointer to the application name obtained if the operation is successful; returns **nullptr** otherwise.|
711
712### OH_UdsAppItem_GetIconId()
713
714```
715const char* OH_UdsAppItem_GetIconId(OH_UdsAppItem* pThis)
716```
717
718**Description**
719
720Obtains the image ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
721
722**Since**: 12
723
724
725**Parameters**
726
727| Name                                       | Description                                                        |
728| --------------------------------------------- | ------------------------------------------------------------ |
729| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
730
731**Returns**
732
733| Type       | Description                                                   |
734| ----------- | ------------------------------------------------------- |
735| const char* | Returns a pointer to the application icon ID obtained if the operation is successful; returns **nullptr** otherwise.|
736
737### OH_UdsAppItem_GetLabelId()
738
739```
740const char* OH_UdsAppItem_GetLabelId(OH_UdsAppItem* pThis)
741```
742
743**Description**
744
745Obtains the label ID from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
746
747**Since**: 12
748
749
750**Parameters**
751
752| Name                                       | Description                                                        |
753| --------------------------------------------- | ------------------------------------------------------------ |
754| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
755
756**Returns**
757
758| Type       | Description                                                   |
759| ----------- | ------------------------------------------------------- |
760| const char* | Returns a pointer to the application label ID obtained if the operation is successful; returns **nullptr** otherwise.|
761
762### OH_UdsAppItem_GetBundleName()
763
764```
765const char* OH_UdsAppItem_GetBundleName(OH_UdsAppItem* pThis)
766```
767
768**Description**
769
770Obtains the bundle name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
771
772**Since**: 12
773
774
775**Parameters**
776
777| Name                                       | Description                                                        |
778| --------------------------------------------- | ------------------------------------------------------------ |
779| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
780
781**Returns**
782
783| Type       | Description                                                       |
784| ----------- | ----------------------------------------------------------- |
785| const char* | Returns a pointer to the bundle name obtained if the operation is successful; returns **nullptr** otherwise.|
786
787### OH_UdsAppItem_GetAbilityName()
788
789```
790const char* OH_UdsAppItem_GetAbilityName(OH_UdsAppItem* pThis)
791```
792
793**Description**
794
795Obtains the ability name from an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
796
797**Since**: 12
798
799
800**Parameters**
801
802| Name                                       | Description                                                        |
803| --------------------------------------------- | ------------------------------------------------------------ |
804| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
805
806**Returns**
807
808| Type       | Description                                                        |
809| ----------- | ------------------------------------------------------------ |
810| const char* | Returns a pointer to the ability name obtained if the operation is successful; returns **nullptr** otherwise.|
811
812### OH_UdsAppItem_SetId()
813
814```
815int OH_UdsAppItem_SetId(OH_UdsAppItem* pThis, const char* appId)
816```
817
818**Description**
819
820Sets the application ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
821
822**Since**: 12
823
824
825**Parameters**
826
827| Name                                       | Description                                                        |
828| --------------------------------------------- | ------------------------------------------------------------ |
829| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
830| const char* appId                             | Pointer to the application ID to set.                                                |
831
832**Returns**
833
834| Type| Description                                                        |
835| ---- | ------------------------------------------------------------ |
836| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
837
838### OH_UdsAppItem_SetName()
839
840```
841int OH_UdsAppItem_SetName(OH_UdsAppItem* pThis, const char* appName)
842```
843
844**Description**
845
846Sets the application name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
847
848**Since**: 12
849
850
851**Parameters**
852
853| Name                                       | Description                                                        |
854| --------------------------------------------- | ------------------------------------------------------------ |
855| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
856| const char* appName                           | Pointer to the application name to set.                                              |
857
858**Returns**
859
860| Type| Description                                                        |
861| ---- | ------------------------------------------------------------ |
862| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
863
864### OH_UdsAppItem_SetIconId()
865
866```
867int OH_UdsAppItem_SetIconId(OH_UdsAppItem* pThis, const char* appIconId)
868```
869
870**Description**
871
872Sets the icon ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
873
874**Since**: 12
875
876
877**Parameters**
878
879| Name                                       | Description                                                        |
880| --------------------------------------------- | ------------------------------------------------------------ |
881| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
882| const char* appIconId                         | Pointer to the application icon ID to set.                                                |
883
884**Returns**
885
886| Type| Description                                                        |
887| ---- | ------------------------------------------------------------ |
888| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
889
890### OH_UdsAppItem_SetLabelId()
891
892```
893int OH_UdsAppItem_SetLabelId(OH_UdsAppItem* pThis, const char* appLabelId)
894```
895
896**Description**
897
898Sets the label ID for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
899
900**Since**: 12
901
902
903**Parameters**
904
905| Name                                       | Description                                                        |
906| --------------------------------------------- | ------------------------------------------------------------ |
907| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
908| const char* appLabelId                        | Pointer to the application label ID to set.                                                |
909
910**Returns**
911
912| Type| Description                                                        |
913| ---- | ------------------------------------------------------------ |
914| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
915
916### OH_UdsAppItem_SetBundleName()
917
918```
919int OH_UdsAppItem_SetBundleName(OH_UdsAppItem* pThis, const char* bundleName)
920```
921
922**Description**
923
924Sets the bundle name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
925
926**Since**: 12
927
928
929**Parameters**
930
931| Name                                       | Description                                                        |
932| --------------------------------------------- | ------------------------------------------------------------ |
933| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
934| const char* bundleName                        | Pointer to the bundle name to set.                                            |
935
936**Returns**
937
938| Type| Description                                                        |
939| ---- | ------------------------------------------------------------ |
940| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
941
942### OH_UdsAppItem_SetAbilityName()
943
944```
945int OH_UdsAppItem_SetAbilityName(OH_UdsAppItem* pThis, const char* abilityName)
946```
947
948**Description**
949
950Sets the ability name for an [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.
951
952**Since**: 12
953
954
955**Parameters**
956
957| Name                                       | Description                                                        |
958| --------------------------------------------- | ------------------------------------------------------------ |
959| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* pThis | Pointer to the [OH_UdsAppItem](capi-udmf-oh-udsappitem.md) instance.|
960| const char* abilityName                       | Pointer to the ability name to set.                                           |
961
962**Returns**
963
964| Type| Description                                                        |
965| ---- | ------------------------------------------------------------ |
966| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
967
968### OH_UdsFileUri_Create()
969
970```
971OH_UdsFileUri* OH_UdsFileUri_Create()
972```
973
974**Description**
975
976Creates an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsFileUri_Destroy](capi-uds-h.md#oh_udsfileuri_destroy) to destroy it. Otherwise, memory leaks may occur.
977
978**Since**: 13
979
980**Returns**
981
982| Type                                   | Description                                                        |
983| --------------------------------------- | ------------------------------------------------------------ |
984| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* | Returns a pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance if the operation is successful; returns **nullptr** otherwise.|
985
986### OH_UdsFileUri_Destroy()
987
988```
989void OH_UdsFileUri_Destroy(OH_UdsFileUri* pThis)
990```
991
992**Description**
993
994Destroys an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
995
996**Since**: 13
997
998
999**Parameters**
1000
1001| Name                                       | Description                                                        |
1002| --------------------------------------------- | ------------------------------------------------------------ |
1003| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1004
1005### OH_UdsFileUri_GetType()
1006
1007```
1008const char* OH_UdsFileUri_GetType(OH_UdsFileUri* pThis)
1009```
1010
1011**Description**
1012
1013Obtains the type ID from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
1014
1015**Since**: 13
1016
1017
1018**Parameters**
1019
1020| Name                                       | Description                                                        |
1021| --------------------------------------------- | ------------------------------------------------------------ |
1022| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1023
1024**Returns**
1025
1026| Type       | Description                                                   |
1027| ----------- | ------------------------------------------------------- |
1028| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
1029
1030### OH_UdsFileUri_GetFileUri()
1031
1032```
1033const char* OH_UdsFileUri_GetFileUri(OH_UdsFileUri* pThis)
1034```
1035
1036**Description**
1037
1038Obtains the file URI from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
1039
1040**Since**: 13
1041
1042
1043**Parameters**
1044
1045| Name                                       | Description                                                        |
1046| --------------------------------------------- | ------------------------------------------------------------ |
1047| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1048
1049**Returns**
1050
1051| Type       | Description                                                    |
1052| ----------- | -------------------------------------------------------- |
1053| const char* | Returns a pointer to the file URI obtained if the operation is successful; returns **nullptr** otherwise.|
1054
1055### OH_UdsFileUri_GetFileType()
1056
1057```
1058const char* OH_UdsFileUri_GetFileType(OH_UdsFileUri* pThis)
1059```
1060
1061**Description**
1062
1063Obtains the file type from an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
1064
1065**Since**: 13
1066
1067
1068**Parameters**
1069
1070| Name                                       | Description                                                        |
1071| --------------------------------------------- | ------------------------------------------------------------ |
1072| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1073
1074**Returns**
1075
1076| Type       | Description                                                     |
1077| ----------- | --------------------------------------------------------- |
1078| const char* | Returns a pointer to the file type obtained if the operation is successful; returns **nullptr** otherwise.|
1079
1080### OH_UdsFileUri_SetFileUri()
1081
1082```
1083int OH_UdsFileUri_SetFileUri(OH_UdsFileUri* pThis, const char* fileUri)
1084```
1085
1086**Description**
1087
1088Sets the URI information for an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
1089
1090**Since**: 13
1091
1092
1093**Parameters**
1094
1095| Name                                       | Description                                                        |
1096| --------------------------------------------- | ------------------------------------------------------------ |
1097| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1098| const char* fileUri                           | Pointer to the file URI to set.                                               |
1099
1100**Returns**
1101
1102| Type| Description                                                        |
1103| ---- | ------------------------------------------------------------ |
1104| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1105
1106### OH_UdsFileUri_SetFileType()
1107
1108```
1109int OH_UdsFileUri_SetFileType(OH_UdsFileUri* pThis, const char* fileType)
1110```
1111
1112**Description**
1113
1114Sets the file type for an [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.
1115
1116**Since**: 13
1117
1118
1119**Parameters**
1120
1121| Name                                       | Description                                                        |
1122| --------------------------------------------- | ------------------------------------------------------------ |
1123| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* pThis | Pointer to the [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md) instance.|
1124| const char* fileType                          | Pointer to the file type to set.                                              |
1125
1126**Returns**
1127
1128| Type| Description                                                        |
1129| ---- | ------------------------------------------------------------ |
1130| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1131
1132### OH_UdsPixelMap_Create()
1133
1134```
1135OH_UdsPixelMap* OH_UdsPixelMap_Create()
1136```
1137
1138**Description**
1139
1140Creates an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsPixelMap_Destroy](capi-uds-h.md#oh_udspixelmap_destroy) to destroy it. Otherwise, memory leaks may occur.
1141
1142**Since**: 13
1143
1144**Returns**
1145
1146| Type                                     | Description                                                        |
1147| ----------------------------------------- | ------------------------------------------------------------ |
1148| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* | Returns a pointer to the [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance if the operation is successful; returns **nullptr** otherwise.|
1149
1150### OH_UdsPixelMap_Destroy()
1151
1152```
1153void OH_UdsPixelMap_Destroy(OH_UdsPixelMap* pThis)
1154```
1155
1156**Description**
1157
1158Destroys an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.
1159
1160**Since**: 13
1161
1162
1163**Parameters**
1164
1165| Name                                         | Description                                                        |
1166| ----------------------------------------------- | ------------------------------------------------------------ |
1167| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pThis | Pointer to the [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
1168
1169### OH_UdsPixelMap_GetType()
1170
1171```
1172const char* OH_UdsPixelMap_GetType(OH_UdsPixelMap* pThis)
1173```
1174
1175**Description**
1176
1177Obtains the type ID from an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.
1178
1179**Since**: 13
1180
1181
1182**Parameters**
1183
1184| Name                                         | Description                                                        |
1185| ----------------------------------------------- | ------------------------------------------------------------ |
1186| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pThis | Pointer to the [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
1187
1188**Returns**
1189
1190| Type       | Description                                                   |
1191| ----------- | ------------------------------------------------------- |
1192| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
1193
1194### OH_UdsPixelMap_GetPixelMap()
1195
1196```
1197void OH_UdsPixelMap_GetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)
1198```
1199
1200**Description**
1201
1202Obtains the pointer to the [OH_PixelmapNative](../apis-image-kit/capi-pixelmap-native-h.md#oh_pixelmapnative_antialiasinglevel) instance from an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.
1203
1204**Since**: 13
1205
1206
1207**Parameters**
1208
1209| Name                                         | Description                                                        |
1210| ----------------------------------------------- | ------------------------------------------------------------ |
1211| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pThis | Pointer to the [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
1212| OH_PixelmapNative* pixelmapNative               | Pointer to the [OH_PixelmapNative](../apis-image-kit/capi-pixelmap-native-h.md#oh_pixelmapnative_antialiasinglevel) instance.|
1213
1214### OH_UdsPixelMap_SetPixelMap()
1215
1216```
1217int OH_UdsPixelMap_SetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)
1218```
1219
1220**Description**
1221
1222Sets the pixel image content for an [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.
1223
1224**Since**: 13
1225
1226
1227**Parameters**
1228
1229| Name                                         | Description                                                        |
1230| ----------------------------------------------- | ------------------------------------------------------------ |
1231| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pThis | Pointer to the [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md) instance.|
1232| OH_PixelmapNative* pixelmapNative               | Pointer to the [OH_PixelmapNative](../apis-image-kit/capi-pixelmap-native-h.md#oh_pixelmapnative_antialiasinglevel) instance.|
1233
1234**Returns**
1235
1236| Type| Description                                                        |
1237| ---- | ------------------------------------------------------------ |
1238| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1239
1240### OH_UdsArrayBuffer_Create()
1241
1242```
1243OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create()
1244```
1245
1246**Description**
1247
1248Creates an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance and a pointer to it. If this pointer is no longer required, use [OH_UdsArrayBuffer_Destroy](capi-uds-h.md#oh_udsarraybuffer_destroy) to destroy it. Otherwise, memory leaks may occur.
1249
1250**Since**: 13
1251
1252**Returns**
1253
1254| Type                                           | Description                                                        |
1255| ----------------------------------------------- | ------------------------------------------------------------ |
1256| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* | Returns a pointer to the [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance if the operation is successful; returns **nullptr** otherwise.|
1257
1258### OH_UdsArrayBuffer_Destroy()
1259
1260```
1261int OH_UdsArrayBuffer_Destroy(OH_UdsArrayBuffer* buffer)
1262```
1263
1264**Description**
1265
1266Destroys an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.
1267
1268**Since**: 13
1269
1270
1271**Parameters**
1272
1273| Name                                                | Description                                                        |
1274| ------------------------------------------------------ | ------------------------------------------------------------ |
1275| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* buffer | Pointer to the [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
1276
1277**Returns**
1278
1279| Type| Description                                                        |
1280| ---- | ------------------------------------------------------------ |
1281| int  | Error codes. For details, see [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1282
1283### OH_UdsArrayBuffer_SetData()
1284
1285```
1286int OH_UdsArrayBuffer_SetData(OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len)
1287```
1288
1289**Description**
1290
1291Sets the data content for an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.
1292
1293**Since**: 13
1294
1295
1296**Parameters**
1297
1298| Name                                                | Description                                                        |
1299| ------------------------------------------------------ | ------------------------------------------------------------ |
1300| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* buffer | Pointer to the [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
1301| unsigned char* data                                    | Pointer to the ArrayBuffer data to set.                           |
1302| unsigned int len                                       | Length of the ArrayBuffer data to set.                     |
1303
1304**Returns**
1305
1306| Type| Description                                                        |
1307| ---- | ------------------------------------------------------------ |
1308| int  | Error codes. For details, see [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1309
1310### OH_UdsArrayBuffer_GetData()
1311
1312```
1313int OH_UdsArrayBuffer_GetData(OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len)
1314```
1315
1316**Description**
1317
1318Obtains the custom ArrayBuffer data from an [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.
1319
1320**Since**: 13
1321
1322
1323**Parameters**
1324
1325| Name                                                | Description                                                        |
1326| ------------------------------------------------------ | ------------------------------------------------------------ |
1327| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* buffer | Pointer to the [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md) instance.|
1328| unsigned char** data                                   | Double pointer to the ArrayBuffer data obtained.         |
1329| unsigned int* len                                      | Pointer to the length of the ArrayBuffer data obtained.   |
1330
1331**Returns**
1332
1333| Type| Description                                                        |
1334| ---- | ------------------------------------------------------------ |
1335| int  | Error codes. For details, see [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1336
1337### OH_UdsContentForm_Create()
1338
1339```
1340OH_UdsContentForm* OH_UdsContentForm_Create()
1341```
1342
1343**Description**
1344
1345Creates an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance and a pointer to it.
1346
1347**Since**: 14
1348
1349**Returns**
1350
1351| Type                                           | Description                                                        |
1352| ----------------------------------------------- | ------------------------------------------------------------ |
1353| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* | Returns a pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance if the operation is successful; returns **nullptr** otherwise.|
1354
1355### OH_UdsContentForm_Destroy()
1356
1357```
1358void OH_UdsContentForm_Destroy(OH_UdsContentForm* pThis)
1359```
1360
1361**Description**
1362
1363Destroys an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1364
1365**Since**: 14
1366
1367
1368**Parameters**
1369
1370| Name                                               | Description                                                        |
1371| ----------------------------------------------------- | ------------------------------------------------------------ |
1372| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1373
1374### OH_UdsContentForm_GetType()
1375
1376```
1377const char* OH_UdsContentForm_GetType(OH_UdsContentForm* pThis)
1378```
1379
1380**Description**
1381
1382Obtains the type ID from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1383
1384**Since**: 14
1385
1386
1387**Parameters**
1388
1389| Name                                               | Description                                                        |
1390| ----------------------------------------------------- | ------------------------------------------------------------ |
1391| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1392
1393**Returns**
1394
1395| Type       | Description                                                   |
1396| ----------- | ------------------------------------------------------- |
1397| const char* | Returns a pointer to the type ID obtained if the operation is successful; returns **nullptr** otherwise.|
1398
1399### OH_UdsContentForm_GetThumbData()
1400
1401```
1402int OH_UdsContentForm_GetThumbData(OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len)
1403```
1404
1405**Description**
1406
1407Obtains the image data from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1408
1409**Since**: 14
1410
1411
1412**Parameters**
1413
1414| Name                                               | Description                                                        |
1415| ----------------------------------------------------- | ------------------------------------------------------------ |
1416| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1417| unsigned char** thumbData                             | Double pointer to the binary image data obtained.          |
1418| unsigned int* len                                     | Pointer to the length of the binary image data obtained.    |
1419
1420**Returns**
1421
1422| Type| Description                                                        |
1423| ---- | ------------------------------------------------------------ |
1424| int  | Error codes. For details, see [OH_UdsContentForm](capi-udmf-oh-udscontentform.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.<br>Returns **UDMF_ERR** if an internal system error occurs.|
1425
1426### OH_UdsContentForm_GetDescription()
1427
1428```
1429const char* OH_UdsContentForm_GetDescription(OH_UdsContentForm* pThis)
1430```
1431
1432**Description**
1433
1434Obtains the description from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1435
1436**Since**: 14
1437
1438
1439**Parameters**
1440
1441| Name                                               | Description                                                        |
1442| ----------------------------------------------------- | ------------------------------------------------------------ |
1443| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1444
1445**Returns**
1446
1447| Type       | Description                                                     |
1448| ----------- | --------------------------------------------------------- |
1449| const char* | Returns a pointer to the description string obtained if the operation is successful; returns **nullptr** otherwise.|
1450
1451### OH_UdsContentForm_GetTitle()
1452
1453```
1454const char* OH_UdsContentForm_GetTitle(OH_UdsContentForm* pThis)
1455```
1456
1457**Description**
1458
1459Obtains the title from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1460
1461**Since**: 14
1462
1463
1464**Parameters**
1465
1466| Name                                               | Description                                                        |
1467| ----------------------------------------------------- | ------------------------------------------------------------ |
1468| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1469
1470**Returns**
1471
1472| Type       | Description                                                     |
1473| ----------- | --------------------------------------------------------- |
1474| const char* | Returns a pointer to the title string obtained if the operation is successful; returns **nullptr** otherwise.|
1475
1476### OH_UdsContentForm_GetAppIcon()
1477
1478```
1479int OH_UdsContentForm_GetAppIcon(OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len)
1480```
1481
1482**Description**
1483
1484Obtains the application icon data from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1485
1486**Since**: 14
1487
1488
1489**Parameters**
1490
1491| Name                                               | Description                                                        |
1492| ----------------------------------------------------- | ------------------------------------------------------------ |
1493| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1494| unsigned char** appIcon                               | Double pointer to the binary application icon data obtained.      |
1495| unsigned int* len                                     | Pointer to the length of the binary application icon data obtained.|
1496
1497**Returns**
1498
1499| Type| Description                                                        |
1500| ---- | ------------------------------------------------------------ |
1501| int  | Error codes. For details, see [OH_UdsContentForm](capi-udmf-oh-udscontentform.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.<br>Returns **UDMF_ERR** if an internal system error occurs.|
1502
1503### OH_UdsContentForm_GetAppName()
1504
1505```
1506const char* OH_UdsContentForm_GetAppName(OH_UdsContentForm* pThis)
1507```
1508
1509**Description**
1510
1511Obtains the application name from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1512
1513**Since**: 14
1514
1515
1516**Parameters**
1517
1518| Name                                               | Description                                                        |
1519| ----------------------------------------------------- | ------------------------------------------------------------ |
1520| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1521
1522**Returns**
1523
1524| Type       | Description                                                        |
1525| ----------- | ------------------------------------------------------------ |
1526| const char* | Returns a pointer to the application name obtained if the operation is successful; returns **nullptr** otherwise.|
1527
1528### OH_UdsContentForm_GetLinkUri()
1529
1530```
1531const char* OH_UdsContentForm_GetLinkUri(OH_UdsContentForm* pThis)
1532```
1533
1534**Description**
1535
1536Obtains the hyperlink from an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1537
1538**Since**: 14
1539
1540
1541**Parameters**
1542
1543| Name                                               | Description                                                        |
1544| ----------------------------------------------------- | ------------------------------------------------------------ |
1545| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1546
1547**Returns**
1548
1549| Type       | Description                                                   |
1550| ----------- | ------------------------------------------------------- |
1551| const char* | Returns a pointer to the hyperlink obtained if the operation is successful; returns **nullptr** otherwise.|
1552
1553### OH_UdsContentForm_SetThumbData()
1554
1555```
1556int OH_UdsContentForm_SetThumbData(OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len)
1557```
1558
1559**Description**
1560
1561Sets the image data for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1562
1563**Since**: 14
1564
1565
1566**Parameters**
1567
1568| Name                                               | Description                                                        |
1569| ----------------------------------------------------- | ------------------------------------------------------------ |
1570| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1571| const unsigned char* thumbData                        | Pointer to the binary image data to set.                            |
1572| unsigned int len                                      | Length of the binary image data to set.                      |
1573
1574**Returns**
1575
1576| Type| Description                                                        |
1577| ---- | ------------------------------------------------------------ |
1578| int  | Error codes. For details, see [OH_UdsContentForm](capi-udmf-oh-udscontentform.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1579
1580### OH_UdsContentForm_SetDescription()
1581
1582```
1583int OH_UdsContentForm_SetDescription(OH_UdsContentForm* pThis, const char* description)
1584```
1585
1586**Description**
1587
1588Sets the description for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1589
1590**Since**: 14
1591
1592
1593**Parameters**
1594
1595| Name                                               | Description                                                        |
1596| ----------------------------------------------------- | ------------------------------------------------------------ |
1597| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1598| const char* description                               | Pointer to the description to set.                                              |
1599
1600**Returns**
1601
1602| Type| Description                                                        |
1603| ---- | ------------------------------------------------------------ |
1604| int  | Error codes. For details, see [OH_UdsContentForm](capi-udmf-oh-udscontentform.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1605
1606### OH_UdsContentForm_SetTitle()
1607
1608```
1609int OH_UdsContentForm_SetTitle(OH_UdsContentForm* pThis, const char* title)
1610```
1611
1612**Description**
1613
1614Sets the title for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1615
1616**Since**: 14
1617
1618
1619**Parameters**
1620
1621| Name                                               | Description                                                        |
1622| ----------------------------------------------------- | ------------------------------------------------------------ |
1623| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1624| const char* title                                     | Pointer to the title to set.                                              |
1625
1626**Returns**
1627
1628| Type| Description                                                        |
1629| ---- | ------------------------------------------------------------ |
1630| int  | Error codes. For details, see [OH_UdsContentForm](capi-udmf-oh-udscontentform.md).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1631
1632### OH_UdsContentForm_SetAppIcon()
1633
1634```
1635int OH_UdsContentForm_SetAppIcon(OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len)
1636```
1637
1638**Description**
1639
1640Sets the application icon data for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1641
1642**Since**: 14
1643
1644
1645**Parameters**
1646
1647| Name                                               | Description                                                        |
1648| ----------------------------------------------------- | ------------------------------------------------------------ |
1649| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1650| const unsigned char* appIcon                          | Pointer to the binary application icon data to set.                        |
1651| unsigned int len                                      | Length of the binary application icon data to set.                  |
1652
1653**Returns**
1654
1655| Type| Description                                                        |
1656| ---- | ------------------------------------------------------------ |
1657| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1658
1659### OH_UdsContentForm_SetAppName()
1660
1661```
1662int OH_UdsContentForm_SetAppName(OH_UdsContentForm* pThis, const char* appName)
1663```
1664
1665**Description**
1666
1667Sets the application name for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1668
1669**Since**: 14
1670
1671
1672**Parameters**
1673
1674| Name                                               | Description                                                        |
1675| ----------------------------------------------------- | ------------------------------------------------------------ |
1676| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1677| const char* appName                                   | Pointer to the application name to set.                                  |
1678
1679**Returns**
1680
1681| Type| Description                                                        |
1682| ---- | ------------------------------------------------------------ |
1683| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1684
1685### OH_UdsContentForm_SetLinkUri()
1686
1687```
1688int OH_UdsContentForm_SetLinkUri(OH_UdsContentForm* pThis, const char* linkUri)
1689```
1690
1691**Description**
1692
1693Sets the hyperlink for an [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.
1694
1695**Since**: 14
1696
1697
1698**Parameters**
1699
1700| Name                                               | Description                                                        |
1701| ----------------------------------------------------- | ------------------------------------------------------------ |
1702| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* pThis | Pointer to the [OH_UdsContentForm](capi-udmf-oh-udscontentform.md) instance.|
1703| const char* linkUri                                   | Pointer to the hyperlink to set.                                    |
1704
1705**Returns**
1706
1707| Type| Description                                                        |
1708| ---- | ------------------------------------------------------------ |
1709| int  | Error codes. For details, see [Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode).<br>Returns **UDMF_E_OK** if the operation is successful.<br>Returns **UDMF_E_INVALID_PARAM** if an invalid parameter is passed in.|
1710