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