UDMF

描述

创建异步获取UDMF数据的请求参数OH_UdmfGetDataParams指针及实例对象。

当不再需要使用指针时，请使用OH_UdmfGetDataParams_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 15

返回：

执行成功则返回一个指向属性OH_UdmfGetDataParams实例对象的指针，否则返回nullptr。

参见：

OH_UdmfGetDataParams_SetDestUri()

void OH_UdmfGetDataParams_SetDestUri (OH_UdmfGetDataParams* params, const char* destUri )

描述

设置异步请求参数OH_UdmfGetDataParams中的目标路径。

若设置了目标路径，会将文件类型的数据进行拷贝到指定路径。回调中获取到的文件类型数据会被替换为目标路径的URI。

若不设置目标路径，则不会执行拷贝文件操作。回调中获取到的文件类型数据为源端路径URI。

若应用涉及复杂文件处理策略，或需要将文件拷贝在多个路径下时，建议不设置此参数，由应用自行完成文件拷贝相关处理。

起始版本： 15

参数:

名称	描述
params	表示指向异步请求参数OH_UdmfGetDataParams实例的指针。
destUri	表示目标路径地址。

参见：

OH_UdmfGetDataParams_SetFileConflictOptions()

void OH_UdmfGetDataParams_SetFileConflictOptions (OH_UdmfGetDataParams* params, const Udmf_FileConflictOptions options )

描述

设置异步请求参数OH_UdmfGetDataParams中的文件冲突选项。

起始版本： 15

参数:

名称	描述
params	表示指向异步请求参数OH_UdmfGetDataParams实例的指针。
options	表示文件拷贝冲突时的选项。

参见：

Udmf_FileConflictOptions

OH_UdmfGetDataParams_SetProgressIndicator()

void OH_UdmfGetDataParams_SetProgressIndicator (OH_UdmfGetDataParams* params, const Udmf_ProgressIndicator progressIndicator )

描述

设置异步请求参数OH_UdmfGetDataParams中的进度条指示选项。

起始版本： 15

参数:

名称	描述
params	表示指向异步请求参数OH_UdmfGetDataParams实例的指针。
progressIndicator	表示是否使用默认进度条选项。

参见：

Udmf_ProgressIndicator

OH_UdmfGetDataParams_SetDataProgressListener()

void OH_UdmfGetDataParams_SetDataProgressListener (OH_UdmfGetDataParams* params, const OH_Udmf_DataProgressListener dataProgressListener )

描述

设置异步请求参数OH_UdmfGetDataParams中的监听回调函数。

起始版本： 15

参数:

名称	描述
params	表示指向异步请求参数OH_UdmfGetDataParams实例的指针。
dataProgressListener	用户自定义的监听回调函数，可用于获取进度信息和数据。

参见：

OH_Udmf_DataProgressListener

OH_UdmfRecord_AddContentForm()

int OH_UdmfRecord_AddContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )

描述

增加一个内容卡片类型OH_UdsContentForm的数据至统一数据记录OH_UdmfRecord中。

起始版本： 14

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
contentForm	表示指向内容卡片类型OH_UdsContentForm实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_GetContentForm()

int OH_UdmfRecord_GetContentForm (OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm )

描述

从统一数据记录OH_UdmfRecord中获取内容卡片类型OH_UdsContentForm数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
contentForm	该参数是输出参数，表示指向内容卡片类型OH_UdsContentForm实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsContentForm_Create()

OH_UdsContentForm* OH_UdsContentForm_Create ()

描述

创建内容卡片类型OH_UdsContentForm指针及实例对象

起始版本： 14

返回：

执行成功则返回一个指向内容卡片类型OH_UdsContentForm实例对象的指针，否则返回nullptr。

参见：

OH_UdsContentForm_Destroy()

void OH_UdsContentForm_Destroy (OH_UdsContentForm* pThis)

描述

销毁内容卡片类型数据OH_UdsContentForm指针指向的实例对象。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

参见：

OH_UdsContentForm_GetAppIcon()

int OH_UdsContentForm_GetAppIcon (OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len )

描述

从内容卡片类型OH_UdsContentForm中获取应用图标数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
appIcon	该参数是输出参数，表示内容卡片中的应用图标二进制数据。
len	该参数是输出参数，表示内容卡片中的应用图标二进制数据的大小。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。若返回UDMF_ERR，表示出现了内部系统错误。

参见：

OH_UdsContentForm_GetAppName()

const char* OH_UdsContentForm_GetAppName (OH_UdsContentForm* pThis)

描述

从内容卡片类型OH_UdsContentForm中获取应用名称信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

返回：

输入有效入参时返回应用名称信息的字符串指针，否则返回nullptr。

参见：

OH_UdsContentForm_GetDescription()

const char* OH_UdsContentForm_GetDescription (OH_UdsContentForm* pThis)

描述

从内容卡片类型OH_UdsContentForm中获取描述信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

返回：

输入有效入参时返回描述信息的字符串指针，否则返回nullptr。

参见：

OH_UdsContentForm_GetLinkUri()

const char* OH_UdsContentForm_GetLinkUri (OH_UdsContentForm* pThis)

描述

从内容卡片类型OH_UdsContentForm中获取超链接信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

返回：

输入有效入参时返回超链接的字符串指针，否则返回nullptr。

参见：

OH_UdsContentForm_GetThumbData()

int OH_UdsContentForm_GetThumbData (OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len )

描述

从内容卡片类型OH_UdsContentForm中获取图片数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
thumbData	该参数是输出参数，表示内容卡片中的图片二进制数据。
len	该参数是输出参数，表示内容卡片中的图片二进制数据的大小。

返回：

参见：

OH_UdsContentForm_GetTitle()

const char* OH_UdsContentForm_GetTitle (OH_UdsContentForm* pThis)

描述

从内容卡片类型OH_UdsContentForm中获取标题信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

返回：

输入有效入参时返回标题信息的字符串指针，否则返回nullptr。

参见：

OH_UdsContentForm_GetType()

const char* OH_UdsContentForm_GetType (OH_UdsContentForm* pThis)

描述

从内容卡片类型OH_UdsContentForm中获取类型ID。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsContentForm_SetAppIcon()

int OH_UdsContentForm_SetAppIcon (OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len )

描述

设置内容卡片类型OH_UdsContentForm中的应用图标数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
appIcon	表示内容卡片中的应用图标二进制数据。
len	表示内容卡片中的应用图标二进制数据的大小。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_UdsContentForm_SetAppName()

int OH_UdsContentForm_SetAppName (OH_UdsContentForm* pThis, const char* appName )

描述

设置内容卡片类型OH_UdsContentForm中的应用名称数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
appName	表示内容卡片中的应用名称。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_UdsContentForm_SetDescription()

int OH_UdsContentForm_SetDescription (OH_UdsContentForm* pThis, const char* description )

描述

设置内容卡片类型OH_UdsContentForm中的描述信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
description	表示描述信息。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_UdsContentForm_SetLinkUri()

int OH_UdsContentForm_SetLinkUri (OH_UdsContentForm* pThis, const char* linkUri )

描述

设置内容卡片类型OH_UdsContentForm中的超链接数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
linkUri	表示内容卡片中的超链接。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_UdsContentForm_SetThumbData()

int OH_UdsContentForm_SetThumbData (OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len )

描述

设置内容卡片类型OH_UdsContentForm中的图片数据。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
thumbData	表示内容卡片中的图片二进制数据。
len	表示内容卡片中的图片二进制数据的大小。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_UdsContentForm_SetTitle()

int OH_UdsContentForm_SetTitle (OH_UdsContentForm* pThis, const char* title )

描述

设置内容卡片类型OH_UdsContentForm中的标题信息。

起始版本： 14

参数:

名称	描述
pThis	表示指向OH_UdsContentForm实例的指针。
title	表示标题信息。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效的参数。

参见：

OH_Udmf_GetUnifiedData()

int OH_Udmf_GetUnifiedData (const char* key, Udmf_Intention intention, OH_UdmfData* unifiedData )

描述

从统一数据管理框架数据库中获取统一数据对象OH_UdmfData数据。

起始版本： 12

参数:

名称	描述
key	表示数据库存储的唯一标识符。
intention	表示数据通路类型Udmf_Intention。
unifiedData	该参数是输出参数，获取到的统一数据对象OH_UdmfData会写入该变量。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。若返回UDMF_ERR，表示内部数据错误。

参见：

Udmf_Intention

OH_Udmf_SetUnifiedData()

int OH_Udmf_SetUnifiedData (Udmf_Intention intention, OH_UdmfData* unifiedData, char* key, unsigned int keyLen )

描述

从统一数据管理框架数据库中写入统一数据对象OH_UdmfData数据。

起始版本： 12

参数:

名称	描述
intention	表示数据通路类型Udmf_Intention。
unifiedData	表示统一数据对象OH_UdmfData数据。
key	表示成功将数据设置到数据库后对应数据的唯一标识符。
keyLen	表示唯一标识符参数的空间大小，内存大小不小于512字节。

返回：

参见：

Udmf_Intention

OH_UdmfData_AddRecord()

int OH_UdmfData_AddRecord (OH_UdmfData* pThis, OH_UdmfRecord* record )

描述

添加一个数据记录OH_UdmfRecord到统一数据对象OH_UdmfData中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfData实例的指针。
record	表示指向统一数据记录OH_UdmfRecord实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfData_Create()

OH_UdmfData* OH_UdmfData_Create ()

描述

创建统一数据对象OH_UdmfData指针及实例对象。当不再需要使用指针时，请使用OH_UdmfData_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行成功则返回一个指向统一数据对象OH_UdmfData实例对象的指针，否则返回nullptr。

参见：

OH_UdmfData_Destroy()

void OH_UdmfData_Destroy (OH_UdmfData* pThis)

描述

销毁统一数据对象OH_UdmfData指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfData实例的指针。

参见：

OH_UdmfData_GetPrimaryHtml()

int OH_UdmfData_GetPrimaryHtml (OH_UdmfData* data, OH_UdsHtml* html )

描述

从统一数据对象OH_UdmfData中获取第一个超文本标记语言类型OH_UdsHtml数据。

起始版本： 13

参数:

名称	描述
data	表示指向统一数据对象OH_UdmfData实例的指针。
html	该参数是输出参数，表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfData_GetPrimaryPlainText()

int OH_UdmfData_GetPrimaryPlainText (OH_UdmfData* data, OH_UdsPlainText* plainText )

描述

从统一数据对象OH_UdmfData中获取第一个纯文本类型OH_UdsPlainText数据。

起始版本： 13

参数:

名称	描述
data	表示指向统一数据对象OH_UdmfData实例的指针。
plainText	该参数是输出参数，表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfData_GetRecord()

OH_UdmfRecord* OH_UdmfData_GetRecord (OH_UdmfData* data, unsigned int index )

描述

获取统一数据对象OH_UdmfData中指定位置的数据记录。

起始版本： 13

参数:

名称	描述
data	表示指向统一数据对象OH_UdmfData实例的指针。
index	表示要获取的统一数据记录OH_UdmfRecord在统一数据对象OH_UdmfData中的下标。

返回：

执行成功时返回统一数据记录OH_UdmfRecord实例对象的指针，否则返回nullptr。

参见：

OH_UdmfData_GetRecordCount()

int OH_UdmfData_GetRecordCount (OH_UdmfData* data)

描述

获取统一数据对象OH_UdmfData中包含的所有记录数量。

起始版本： 13

参数:

名称	描述
data	表示指向统一数据对象OH_UdmfData实例的指针。

OH_UdmfData_GetRecords()

OH_UdmfRecord** OH_UdmfData_GetRecords (OH_UdmfData* pThis, unsigned int* count )

描述

获取统一数据对象OH_UdmfData中包含的所有记录结果集。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfData实例的指针。
count	该参数是输出参数，结果集中的记录数量会写入该变量。

返回：

执行成功时返回统一数据记录OH_UdmfRecord结果集，否则返回nullptr。

参见：

OH_UdmfData_GetTypes()

char** OH_UdmfData_GetTypes (OH_UdmfData* pThis, unsigned int* count )

描述

获取统一数据对象OH_UdmfData中包含的所有类型结果集。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfData实例的指针。
count	该参数是输出参数，结果集中的类型数量会写入该变量。

返回：

执行成功时返回统一数据对象的类型结果集，否则返回nullptr。

参见：

OH_UdmfData_HasType()

bool OH_UdmfData_HasType (OH_UdmfData* pThis, const char* type )

描述

检查统一数据对象OH_UdmfData中是否存在指定类型。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfData实例的指针。
type	表示指定类型的字符串指针。

返回：

返回查找类型的状态。返回false表示不存在指定类型，返回true表示存在指定类型。

参见：

OH_UdmfData_IsLocal()

bool OH_UdmfData_IsLocal (OH_UdmfData* data)

描述

检查统一数据对象OH_UdmfData是否是来自本端设备的数据。

起始版本： 13

参数:

名称	描述
data	表示指向统一数据对象OH_UdmfData实例的指针。

返回：

返回数据是否是来自本端设备。返回true表示来自本端设备，返回false表示来自远端设备。

参见：

OH_UdmfProperty_Create()

OH_UdmfProperty* OH_UdmfProperty_Create (OH_UdmfData* unifiedData)

描述

创建统一数据对象中数据记录属性OH_UdmfProperty指针及实例对象。当不再需要使用指针时，请使用OH_UdmfProperty_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

参数:

名称	描述
unifiedData	表示指向统一数据对象OH_UdmfData实例的指针。

返回：

执行成功则返回一个指向属性OH_UdmfProperty实例对象的指针，否则返回nullptr。

参见：

OH_UdmfProperty_Destroy()

void OH_UdmfProperty_Destroy (OH_UdmfProperty* pThis)

描述

销毁数据属性OH_UdmfProperty指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。

参见：

OH_UdmfProperty_GetExtrasIntParam()

int OH_UdmfProperty_GetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int defaultValue )

描述

从数据属性OH_UdmfProperty中获取自定义的附加整型参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。
key	表示键值对的键。
defaultValue	用于用户自行设置获取值失败时的默认值。

返回：

执行成功返回指定的键关联的整型值，否则返回用户设置的默认值defaultValue。

参见：

OH_UdmfProperty_GetExtrasStringParam()

const char* OH_UdmfProperty_GetExtrasStringParam (OH_UdmfProperty* pThis, const char* key )

描述

从数据属性OH_UdmfProperty中获取自定义的附加字符串参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。
key	表示键值对的键。

返回：

执行成功时返回指定的键关联的字符串值的指针，否则返回nullptr。

参见：

OH_UdmfProperty_GetShareOption()

Udmf_ShareOption OH_UdmfProperty_GetShareOption (OH_UdmfProperty* pThis)

描述

从数据属性OH_UdmfProperty中获取设备内适用范围属性。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。

返回：

返回设备内适用范围属性Udmf_ShareOption值。

参见：

Udmf_ShareOption

OH_UdmfProperty_GetTag()

const char* OH_UdmfProperty_GetTag (OH_UdmfProperty* pThis)

描述

从数据属性OH_UdmfProperty中获取用户自定义标签值。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。

返回：

执行成功时返回自定义标签值的字符串指针，否则返回nullptr。

参见：

OH_UdmfProperty_GetTimestamp()

int64_t OH_UdmfProperty_GetTimestamp (OH_UdmfProperty* pThis)

描述

从数据属性OH_UdmfProperty中获取时间戳。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。

返回：

返回时间戳值。

参见：

OH_UdmfProperty_SetExtrasIntParam()

int OH_UdmfProperty_SetExtrasIntParam (OH_UdmfProperty* pThis, const char* key, int param )

描述

设置数据属性OH_UdmfProperty的附加整型参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向OH_UdmfRecord实例的指针。
key	表示键值对的键。
param	表示键值对的值。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfProperty_SetExtrasStringParam()

int OH_UdmfProperty_SetExtrasStringParam (OH_UdmfProperty* pThis, const char* key, const char* param )

描述

设置数据属性OH_UdmfProperty的附加字符串参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfRecord实例的指针。
key	表示键值对的键。
param	表示键值对的值。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfProperty_SetShareOption()

int OH_UdmfProperty_SetShareOption (OH_UdmfProperty* pThis, Udmf_ShareOption option )

描述

设置数据属性OH_UdmfProperty的设备内适用范围OH_Udmf_ShareOption参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。
option	表示设备内适用范围Udmf_ShareOption参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

Udmf_ShareOption

OH_UdmfProperty_SetTag()

int OH_UdmfProperty_SetTag (OH_UdmfProperty* pThis, const char* tag )

描述

设置数据属性OH_UdmfProperty的自定义标签值。

起始版本： 12

参数:

名称	描述
pThis	表示指向数据属性OH_UdmfProperty实例的指针。
tag	表示自定义标签值。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddAppItem()

int OH_UdmfRecord_AddAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )

描述

增加桌面图标类型OH_UdsAppItem数据至统一数据记录OH_UdmfRecord中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
appItem	表示指向桌面图标类型OH_UdsAppItem实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddArrayBuffer()

int OH_UdmfRecord_AddArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )

描述

增加一个ArrayBuffer类型OH_UdsArrayBuffer的数据至统一数据记录OH_UdmfRecord中。

起始版本： 13

参数:

名称	描述
record	表示指向统一数据记录OH_UdmfRecord实例的指针。
type	表示自定义的ArrayBuffer数据的数据类型标识，不可与已有的数据类型标识重复。
buffer	表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddFileUri()

int OH_UdmfRecord_AddFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )

描述

增加文件Uri类型OH_UdsFileUri数据至统一数据记录OH_UdmfRecord中。

起始版本： 13

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
fileUri	表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddGeneralEntry()

int OH_UdmfRecord_AddGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char* entry, unsigned int count )

描述

添加用户自定义的通用数据至统一数据记录OH_UdmfRecord中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
typeId	表示数据类型标识。
entry	表示用户自定义数据。
count	表示用户自定义数据的大小。数据大小不超过4KB。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddHtml()

int OH_UdmfRecord_AddHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )

描述

增加超文本标记语言类型OH_UdsHtml数据至统一数据记录OH_UdmfRecord中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
html	表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddHyperlink()

int OH_UdmfRecord_AddHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )

描述

增加超链接类型OH_UdsHyperlink数据至统一数据记录OH_UdmfRecord中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
hyperlink	表示指向超链接类型OH_UdsHyperlink实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddPixelMap()

int OH_UdmfRecord_AddPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )

描述

增加像素图片类型OH_UdsPixelMap数据至统一数据记录OH_UdmfRecord中。

起始版本： 13

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
pixelMap	表示指向像素图片类型OH_UdsPixelMap实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_AddPlainText()

int OH_UdmfRecord_AddPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )

描述

增加纯文本类型OH_UdsPlainText数据至统一数据记录OH_UdmfRecord中。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
plainText	表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_Create()

OH_UdmfRecord* OH_UdmfRecord_Create ()

描述

创建统一数据记录OH_UdmfRecord指针及实例对象。当不再需要使用指针时，请使用OH_UdmfRecord_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行成功则返回一个指向统一数据记录OH_UdmfRecord实例对象的指针，否则返回nullptr。

参见：

OH_UdmfRecord_Destroy()

void OH_UdmfRecord_Destroy (OH_UdmfRecord* pThis)

描述

销毁统一数据记录OH_UdmfRecord指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据对象OH_UdmfRecord实例的指针。

参见：

OH_UdmfRecord_GetAppItem()

int OH_UdmfRecord_GetAppItem (OH_UdmfRecord* pThis, OH_UdsAppItem* appItem )

描述

从统一数据记录OH_UdmfRecord中获取桌面图标类型OH_UdsAppItem数据。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
appItem	该参数是输出参数，表示指向桌面图标类型OH_UdsAppItem实例的指针。

返回：

参见：

OH_UdmfRecord_GetArrayBuffer()

int OH_UdmfRecord_GetArrayBuffer (OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer )

描述

从统一数据记录OH_UdmfRecord中获取ArrayBuffer类型OH_UdsArrayBuffer数据。

起始版本： 13

参数:

名称	描述
record	表示指向统一数据记录OH_UdmfRecord实例的指针。
type	表示要获取的ArrayBuffer类型数据的数据类型标识。
buffer	该参数是输出参数，表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_GetFileUri()

int OH_UdmfRecord_GetFileUri (OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri )

描述

从统一数据记录OH_UdmfRecord中获取文件Uri类型OH_UdsFileUri数据。

起始版本： 13

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
fileUri	该参数是输出参数，表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_GetGeneralEntry()

int OH_UdmfRecord_GetGeneralEntry (OH_UdmfRecord* pThis, const char* typeId, unsigned char** entry, unsigned int* count )

描述

获取统一数据记录OH_UdmfRecord中的特定类型的数据结果集。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
typeId	表示数据类型标识。
entry	该参数是输出参数，结果集中数据的具体信息会写入该变量。
count	该参数是输出参数，结果集中的数据长度会写入该变量。

返回：

参见：

OH_UdmfRecord_GetHtml()

int OH_UdmfRecord_GetHtml (OH_UdmfRecord* pThis, OH_UdsHtml* html )

描述

从统一数据记录OH_UdmfRecord中获取超文本标记语言类型OH_UdsHtml数据。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
html	该参数是输出参数，表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

参见：

OH_UdmfRecord_GetHyperlink()

int OH_UdmfRecord_GetHyperlink (OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink )

描述

从统一数据记录OH_UdmfRecord中获取超链接类型OH_UdsHyperlink数据。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
hyperlink	该参数是输出参数，表示指向超链接类型OH_UdsHyperlink实例的指针。

返回：

参见：

OH_UdmfRecord_GetPixelMap()

int OH_UdmfRecord_GetPixelMap (OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap )

描述

从统一数据记录OH_UdmfRecord中获取像素图片类型OH_UdsPixelMap数据。

起始版本： 13

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
pixelMap	该参数是输出参数，表示指向像素图片类型OH_UdsPixelMap实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecord_GetPlainText()

int OH_UdmfRecord_GetPlainText (OH_UdmfRecord* pThis, OH_UdsPlainText* plainText )

描述

从统一数据记录OH_UdmfRecord中获取纯文本类型OH_UdsPlainText数据。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
plainText	该参数是输出参数，表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

参见：

OH_UdmfRecord_GetTypes()

char** OH_UdmfRecord_GetTypes (OH_UdmfRecord* pThis, unsigned int* count )

描述

获取统一数据记录OH_UdmfRecord中所有类型的结果集。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
count	该参数是输出参数，结果集中的类型数量会写入该变量。

返回：

执行成功时返回类型列表，否则返回nullptr。

参见：

OH_UdmfRecord_SetProvider()

int OH_UdmfRecord_SetProvider (OH_UdmfRecord* pThis, const char* const* types, unsigned int count, OH_UdmfRecordProvider* provider )

描述

将指定类型的统一数据提供者OH_UdmfRecordProvider设置至统一数据记录OH_UdmfRecord中。

起始版本： 13

参数:

名称	描述
pThis	表示指向统一数据记录OH_UdmfRecord实例的指针。
types	表示一组指定的要提供的数据类型。
count	表示指定的数据类型的数量。
provider	表示指向统一数据提供者对象OH_UdmfRecordProvider实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecordProvider_Create()

OH_UdmfRecordProvider* OH_UdmfRecordProvider_Create ()

描述

创建一个统一数据提供者OH_UdmfRecordProvider指针及实例对象。当不再需要使用指针时，请使用OH_UdmfRecordProvider_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 13

返回：

执行成功时返回一个指向统一数据提供者OH_UdmfRecordProvider实例对象的指针，否则返回nullptr。

参见：

OH_UdmfRecordProvider_Destroy()

int OH_UdmfRecordProvider_Destroy (OH_UdmfRecordProvider* provider)

描述

销毁统一数据提供者OH_UdmfRecordProvider指针指向的实例对象。

起始版本： 13

参数:

名称	描述
provider	表示指向统一数据提供者对象OH_UdmfRecordProvider实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecordProvider_SetData()

int OH_UdmfRecordProvider_SetData (OH_UdmfRecordProvider* provider, void* context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize )

描述

设置统一数据提供者的数据提供回调函数。

起始版本： 13

参数:

名称	描述
provider	指向统一数据提供者OH_UdmfRecordProvider实例对象的指针。
context	上下文指针，将作为第一个参数传入OH_UdmfRecordProvider_GetData。
callback	获取数据的回调函数。详见：OH_UdmfRecordProvider_GetData。
finalize	可选的回调函数，可以用于统一数据提供者销毁时释放上下文数据。详见：UdmfData_Finalize。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdmfRecordProvider_GetData

UdmfData_Finalize Udmf_ErrCode

OH_UdsAppItem_Create()

OH_UdsAppItem* OH_UdsAppItem_Create ()

描述

创建桌面图标类型OH_UdsAppItem指针及实例对象。当不再需要使用指针时，请使用OH_UdsAppItem_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行成功返则回一个指向桌面图标类型OH_UdsAppItem实例对象的指针，否则返回nullptr。

参见：

OH_UdsAppItem_Destroy()

void OH_UdsAppItem_Destroy (OH_UdsAppItem* pThis)

描述

销毁桌面图标类型OH_UdsAppItem指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

参见：

OH_UdsAppItem_GetAbilityName()

const char* OH_UdsAppItem_GetAbilityName (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中ability名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回ability名称的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetBundleName()

const char* OH_UdsAppItem_GetBundleName (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中获取bundle名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回bundle名称的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetIconId()

const char* OH_UdsAppItem_GetIconId (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中获取图片ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回图片ID的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetId()

const char* OH_UdsAppItem_GetId (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中获取应用ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回应用ID的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetLabelId()

const char* OH_UdsAppItem_GetLabelId (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中获取标签ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回标签ID的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetName()

const char* OH_UdsAppItem_GetName (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例中获取应用名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回应用名称的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_GetType()

const char* OH_UdsAppItem_GetType (OH_UdsAppItem* pThis)

描述

从桌面图标类型OH_UdsAppItem实例获取类型ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsAppItem_SetAbilityName()

int OH_UdsAppItem_SetAbilityName (OH_UdsAppItem* pThis, const char* abilityName )

描述

设置桌面图标类型OH_UdsAppItem对象的ability名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
abilityName	表示ability名称。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsAppItem_SetBundleName()

int OH_UdsAppItem_SetBundleName (OH_UdsAppItem* pThis, const char* bundleName )

描述

设置桌面图标类型OH_UdsAppItem对象的bundle名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
bundleName	表示bundle名称。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsAppItem_SetIconId()

int OH_UdsAppItem_SetIconId (OH_UdsAppItem* pThis, const char* appIconId )

描述

设置桌面图标类型OH_UdsAppItem对象的图片ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
appIconId	表示图片ID。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsAppItem_SetId()

int OH_UdsAppItem_SetId (OH_UdsAppItem* pThis, const char* appId )

描述

设置桌面图标类型OH_UdsAppItem对象的应用ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
appId	表示应用ID。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsAppItem_SetLabelId()

int OH_UdsAppItem_SetLabelId (OH_UdsAppItem* pThis, const char* appLabelId )

描述

设置桌面图标类型OH_UdsAppItem对象的标签ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
appLabelId	表示标签ID。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsAppItem_SetName()

int OH_UdsAppItem_SetName (OH_UdsAppItem* pThis, const char* appName )

描述

设置桌面图标类型OH_UdsAppItem对象的应用名称。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向桌面图标类型OH_UdsAppItem对象的指针。
appName	表示应用名称。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsArrayBuffer_Create()

OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create ()

描述

创建ArrayBuffer类型OH_UdsArrayBuffer的实例对象以及指向它的指针。当不再需要使用指针时，请使用OH_UdsArrayBuffer_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 13

返回：

执行成功则返回一个指向ArrayBuffer类型OH_UdsArrayBuffer实例对象的指针，否则返回nullptr。

参见：

OH_UdsArrayBuffer_Destroy()

int OH_UdsArrayBuffer_Destroy (OH_UdsArrayBuffer* buffer)

描述

销毁ArrayBuffer类型OH_UdsArrayBuffer的实例对象。

起始版本： 13

参数:

名称	描述
buffer	表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsArrayBuffer_GetData()

int OH_UdsArrayBuffer_GetData (OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len )

描述

从ArrayBuffer类型OH_UdsArrayBuffer实例中获取用户自定义的ArrayBuffer数据内容。

起始版本： 13

参数:

名称	描述
buffer	表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。
data	该参数是输出参数，表示用户自定义的ArrayBuffer数据。
len	该参数是输出参数，表示用户自定义的ArrayBuffer数据的大小。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsArrayBuffer_SetData()

int OH_UdsArrayBuffer_SetData (OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len )

描述

设置ArrayBuffer类型OH_UdsArrayBuffer对象的数据内容。

起始版本： 13

参数:

名称	描述
buffer	表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。
data	表示用户自定义的ArrayBuffer数据。
len	表示用户自定义的ArrayBuffer数据的大小。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsFileUri_Create()

OH_UdsFileUri* OH_UdsFileUri_Create ()

描述

创建文件Uri类型OH_UdsFileUri的实例对象以及指向它的指针。当不再需要使用指针时，请使用OH_UdsFileUri_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 13

返回：

执行成功则返回一个指向文件Uri类型OH_UdsFileUri实例对象的指针，否则返回nullptr。

参见：

OH_UdsFileUri_Destroy()

void OH_UdsFileUri_Destroy (OH_UdsFileUri* pThis)

描述

销毁文件Uri类型OH_UdsFileUri的实例对象。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。

参见：

OH_UdsFileUri_GetFileType()

const char* OH_UdsFileUri_GetFileType (OH_UdsFileUri* pThis)

描述

从文件Uri类型OH_UdsFileUri实例中获取文件类型。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回：

输入有效入参时返回文件类型的字符串指针，否则返回nullptr。

参见：

OH_UdsFileUri_GetFileUri()

const char* OH_UdsFileUri_GetFileUri (OH_UdsFileUri* pThis)

描述

从文件Uri类型OH_UdsFileUri实例中获取文件Uri。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回：

输入有效入参时返回文件Uri的字符串指针，否则返回nullptr。

参见：

OH_UdsFileUri_GetType()

const char* OH_UdsFileUri_GetType (OH_UdsFileUri* pThis)

描述

从文件Uri类型OH_UdsFileUri实例中获取类型ID。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsFileUri_SetFileType()

int OH_UdsFileUri_SetFileType (OH_UdsFileUri* pThis, const char* fileType )

描述

设置文件Uri类型OH_UdsFileUri对象的文件类型。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。
fileType	表示文件类型。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsFileUri_SetFileUri()

int OH_UdsFileUri_SetFileUri (OH_UdsFileUri* pThis, const char* fileUri )

描述

设置文件Uri类型OH_UdsFileUri对象的Uri信息。

起始版本： 13

参数:

名称	描述
pThis	表示指向文件Uri类型OH_UdsFileUri实例的指针。
fileUri	表示文件Uri。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsHtml_Create()

OH_UdsHtml* OH_UdsHtml_Create ()

描述

创建超文本标记语言类型OH_UdsHtml指针及实例对象。当不再需要使用指针时，请使用OH_UdsHtml_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行成功则返回一个指向超文本标记语言类型OH_UdsHtml实例对象的指针，否则返回nullptr。

参见：

OH_UdsHtml_Destroy()

void OH_UdsHtml_Destroy (OH_UdsHtml* pThis)

描述

销毁超文本标记语言类型OH_UdsHtml指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。

参见：

OH_UdsHtml_GetContent()

const char* OH_UdsHtml_GetContent (OH_UdsHtml* pThis)

描述

获取超文本标记语言类型OH_UdsHtml对象中HTML格式内容参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

输入有效入参时返回HTML格式内容的字符串指针，否则返回nullptr。

参见：

OH_UdsHtml_GetPlainContent()

const char* OH_UdsHtml_GetPlainContent (OH_UdsHtml* pThis)

描述

获取超文本标记语言类型OH_UdsHtml对象中的纯文本内容参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

输入有效入参时返回纯文本内容的字符串指针，否则返回nullptr。

参见：

OH_UdsHtml_GetType()

const char* OH_UdsHtml_GetType (OH_UdsHtml* pThis)

描述

获取超文本标记语言类型OH_UdsHtml对象中类型ID。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsHtml_SetContent()

int OH_UdsHtml_SetContent (OH_UdsHtml* pThis, const char* content )

描述

设置超文本标记语言类型OH_UdsHtml中的HTML格式内容参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。
content	表示HTML格式内容参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsHtml_SetPlainContent()

int OH_UdsHtml_SetPlainContent (OH_UdsHtml* pThis, const char* plainContent )

描述

设置超文本标记语言类型OH_UdsHtml中的纯文本内容参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超文本标记语言类型OH_UdsHtml实例的指针。
plainContent	表示纯文本内容参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsHyperlink_Create()

OH_UdsHyperlink* OH_UdsHyperlink_Create ()

描述

创建超链接类型OH_UdsHyperlink指针及实例对象。当不再需要使用指针时，请使用OH_UdsHyperlink_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行则成功返回一个指向超链接类型OH_UdsHyperlink实例对象的指针，否则返回nullptr。

参见：

OH_UdsHyperlink_Destroy()

void OH_UdsHyperlink_Destroy (OH_UdsHyperlink* pThis)

描述

销毁超链接类型OH_UdsHyperlink指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。

参见：

OH_UdsHyperlink_GetDescription()

const char* OH_UdsHyperlink_GetDescription (OH_UdsHyperlink* pThis)

描述

从超链接类型OH_UdsHyperlink中获取描述参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。

返回：

输入有效入参时返回描述参数的字符串指针，否则返回nullptr。

参见：

OH_UdsHyperlink_GetType()

const char* OH_UdsHyperlink_GetType (OH_UdsHyperlink* pThis)

描述

从超链接类型OH_UdsHyperlink中获取类型ID。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsHyperlink_GetUrl()

const char* OH_UdsHyperlink_GetUrl (OH_UdsHyperlink* pThis)

描述

从超链接类型OH_UdsHyperlink中获取URL参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。

返回：

输入有效入参时返回URL参数的字符串指针，否则返回nullptr。

参见：

OH_UdsHyperlink_SetDescription()

int OH_UdsHyperlink_SetDescription (OH_UdsHyperlink* pThis, const char* description )

描述

设置超链接类型OH_UdsHyperlink实例中描述参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。
description	表示描述信息。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsHyperlink_SetUrl()

int OH_UdsHyperlink_SetUrl (OH_UdsHyperlink* pThis, const char* url )

描述

设置超链接类型OH_UdsHyperlink实例中URL参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向超链接类型OH_UdsHyperlink实例的指针。
url	表示URL参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsPixelMap_Create()

OH_UdsPixelMap* OH_UdsPixelMap_Create ()

描述

创建像素图片类型OH_UdsPixelMap的实例对象以及指向它的指针。当不再需要使用指针时，请使用OH_UdsPixelMap_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 13

返回：

执行成功则返回一个指向像素图片类型OH_UdsPixelMap实例对象的指针，否则返回nullptr。

参见：

OH_UdsPixelMap_Destroy()

void OH_UdsPixelMap_Destroy (OH_UdsPixelMap* pThis)

描述

销毁像素图片类型OH_UdsPixelMap的实例对象。

起始版本： 13

参数:

名称	描述
pThis	表示指向像素图片类型OH_UdsPixelMap实例的指针。

参见：

OH_UdsPixelMap_GetPixelMap()

void OH_UdsPixelMap_GetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )

描述

从像素图片类型OH_UdsPixelMap实例中获取像素图片OH_PixelmapNative实例的指针。

起始版本： 13

参数:

名称	描述
pThis	表示指向像素图片类型OH_UdsPixelMap实例的指针。
pixelmapNative	该参数是输出参数，表示指向像素图片OH_PixelmapNative实例的指针。

参见：

OH_PixelmapNative

OH_UdsPixelMap_GetType()

const char* OH_UdsPixelMap_GetType (OH_UdsPixelMap* pThis)

描述

从像素图片类型OH_UdsPixelMap实例中获取类型ID。

起始版本： 13

参数:

名称	描述
pThis	表示指向像素图片类型OH_UdsPixelMap实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsPixelMap_SetPixelMap()

int OH_UdsPixelMap_SetPixelMap (OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative )

描述

设置像素图片类型OH_UdsPixelMap对象的像素图片内容。

起始版本： 13

参数:

名称	描述
pThis	表示指向像素图片类型OH_UdsPixelMap实例的指针。
pixelmapNative	表示指向像素图片OH_PixelmapNative实例的指针

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_PixelmapNative

OH_UdsPlainText_Create()

OH_UdsPlainText* OH_UdsPlainText_Create ()

描述

创建纯文本类型OH_UdsPlainText指针及实例对象。当不再需要使用指针时，请使用OH_UdsPlainText_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 12

返回：

执行成功则返回一个指向纯文本类型OH_UdsPlainText实例对象的指针，否则返回nullptr。

参见：

OH_UdsPlainText_Destroy()

void OH_UdsPlainText_Destroy (OH_UdsPlainText* pThis)

描述

销毁纯文本类型数据OH_UdsPlainText指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向OH_UdsPlainText实例的指针。

参见：

OH_UdsPlainText_GetAbstract()

const char* OH_UdsPlainText_GetAbstract (OH_UdsPlainText* pThis)

描述

从纯文本类型OH_UdsPlainText中获取纯文本摘要信息。

起始版本： 12

参数:

名称	描述
pThis	表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

输入有效入参时返回纯文本摘要信息的字符串指针，否则返回nullptr。

参见：

OH_UdsPlainText_GetContent()

const char* OH_UdsPlainText_GetContent (OH_UdsPlainText* pThis)

描述

从纯文本类型OH_UdsPlainText中获取纯文本内容信息。

起始版本： 12

参数:

名称	描述
pThis	表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

输入有效入参时返回纯文本内容信息的字符串指针，否则返回nullptr。

参见：

OH_UdsPlainText_GetType()

const char* OH_UdsPlainText_GetType (OH_UdsPlainText* pThis)

描述

从纯文本类型OH_UdsPlainText中获取类型ID。

起始版本： 12

参数:

名称	描述
pThis	表示指向纯文本类型OH_UdsPlainText实例的指针。

返回：

输入有效入参时返回类型ID的字符串指针，否则返回nullptr。

参见：

OH_UdsPlainText_SetAbstract()

int OH_UdsPlainText_SetAbstract (OH_UdsPlainText* pThis, const char* abstract )

描述

设置纯文本类型OH_UdsPlainText中的纯文本摘要参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向纯文本类型OH_UdsPlainText实例的指针。
abstract	表示纯文本摘要参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_UdsPlainText_SetContent()

int OH_UdsPlainText_SetContent (OH_UdsPlainText* pThis, const char* content )

描述

设置纯文本类型OH_UdsPlainText中的纯文本内容参数。

起始版本： 12

参数:

名称	描述
pThis	表示指向纯文本类型OH_UdsPlainText实例的指针。
content	表示纯文本内容参数。

返回：

返回执行的错误码。请参阅错误码定义Udmf_ErrCode。若返回UDMF_E_OK，表示执行成功。若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。

参见：

OH_Utd_BelongsTo()

bool OH_Utd_BelongsTo (const char* srcTypeId, const char* destTypeId )

描述

判断两个标准化数据描述类型是否存在归属关系。

起始版本： 12

参数:

名称	描述
srcTypeId	表示原标准化数据类型。
destTypeId	表示目标标准化数据类型。

返回：

false表示原类型不属于目标类型；true表示原类型属于目标类型。

OH_Utd_Create()

OH_Utd* OH_Utd_Create (const char* typeId)

描述

创建统一数据类型OH_Utd指针及实例对象。

起始版本： 12

参数:

名称	描述
typeId	表示统一数据类型ID。

返回：

执行成功则返回一个指向统一数据类型OH_Utd实例对象的指针，否则返回nullptr。当不再需要使用指针时，请使用OH_Utd_Destroy销毁实例对象，否则会导致内存泄漏。

参见：

OH_Utd_Destroy()

void OH_Utd_Destroy (OH_Utd* pThis)

描述

销毁统一数据类型OH_Utd指针指向的实例对象。

起始版本： 12

参数:

名称	描述
pThis	表示指向统一数据类型OH_Utd实例的指针。

参见：

OH_Utd_DestroyStringList()

void OH_Utd_DestroyStringList (const char** list, unsigned int count )

描述

销毁标准数据描述类型结果集字符串列表。

起始版本： 12

参数:

名称	描述
list	表示字符串列表指针。
count	表示字符串列表list参数中的列表长度。

OH_Utd_Equals()

bool OH_Utd_Equals (OH_Utd* utd1, OH_Utd* utd2 )

描述

判断两个标准化数据描述类型是否相等。

起始版本： 12

参数:

名称	描述
desc1	表示一个指向标准化数据描述类型OH_Utd对象的指针。
desc2	表示一个指向标准化数据描述类型OH_Utd对象的指针。

返回：

false表示两种类型不相等；true表示两种类型相等。

OH_Utd_GetBelongingToTypes()

const char** OH_Utd_GetBelongingToTypes (OH_Utd* pThis, unsigned int* count )

描述

获取统一数据类型OH_Utd中的归属关系结果集。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。
count	该参数是输出参数，结果集中的类型数量会写入该变量。

返回：

当入参有效时返回归属关系结果集的字符串指针列表，否则返回nullptr。

参见：

OH_Utd_GetDescription()

const char* OH_Utd_GetDescription (OH_Utd* pThis)

描述

获取统一数据类型OH_Utd中的描述信息。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。

返回：

当入参有效时返回指向描述信息的字符串指针，否则返回nullptr。

参见：

OH_Utd_GetFilenameExtensions()

const char** OH_Utd_GetFilenameExtensions (OH_Utd* pThis, unsigned int* count )

描述

获取统一数据类型OH_Utd所关联的的文件名后缀结果集。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。
count	该参数是输出参数，结果集中的文件后缀名数量会写入该变量。

返回：

当入参有效时返回文件文件名后缀结果集的字符串指针列表，否则返回nullptr。

参见：

OH_Utd_GetIconFile()

const char* OH_Utd_GetIconFile (OH_Utd* pThis)

描述

获取统一数据类型OH_Utd中的默认图标文件路径。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。

返回：

当入参有效时返回指向默认图标文件路径的字符串指针，否则返回nullptr。

参见：

OH_Utd_GetMimeTypes()

const char** OH_Utd_GetMimeTypes (OH_Utd* pThis, unsigned int* count )

描述

获取OH_Utd所关联的MIME类型结果集。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。
count	该参数是输出参数，结果集中的MIME类型数量会写入该变量。

返回：

当入参有效时返回MIME类型结果集的字符串指针列表，否则返回nullptr。

参见：

OH_Utd_GetReferenceUrl()

const char* OH_Utd_GetReferenceUrl (OH_Utd* pThis)

描述

获取统一数据类型OH_Utd中的URL信息。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。

返回：

当入参有效时返回指向URL信息的字符串指针，否则返回nullptr。

参见：

OH_Utd_GetTypeId()

const char* OH_Utd_GetTypeId (OH_Utd* pThis)

描述

获取统一数据类型OH_Utd中的类型ID。

起始版本： 12

参数:

名称	描述
pThis	表示一个指向统一数据类型OH_Utd对象的指针。

返回：

当入参有效时返回指向类型ID的字符串指针，否则返回nullptr。

参见：