1# udmf.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/udmf.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_UdmfData](capi-udmf-oh-udmfdata.md) | OH_UdmfData | 定义统一数据对象数据结构。 | 30| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md) | OH_UdmfRecord | 定义统一数据对象中记录数据的数据结构，称为数据记录。 | 31| [OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md) | OH_UdmfRecordProvider | 定义统一数据对象中的数据提供者。 | 32| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md) | OH_UdmfProperty | 定义统一数据对象中数据记录的属性结构。 | 33| [OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md) | OH_Udmf_ProgressInfo | 定义进度信息的数据结构。 | 34| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md) | OH_UdmfGetDataParams | 定义异步获取UDMF数据的请求参数。 | 35| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md) | OH_UdmfOptions | 数据操作选项，定义数据操作的可选参数。 | 36| [OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md) | OH_UdmfDataLoadParams | 表示数据加载参数结构体。 | 37| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md) | OH_UdmfDataLoadInfo | 表示数据加载信息结构体。 | 38 39### 枚举 40 41| 名称 | typedef关键字 | 描述 | 42| -- | -- | -- | 43| [Udmf_Intention](#udmf_intention) | Udmf_Intention | 描述UDMF数据通路枚举类型。 | 44| [Udmf_ShareOption](#udmf_shareoption) | Udmf_ShareOption | UDMF支持的设备内使用范围类型枚举。 | 45| [Udmf_FileConflictOptions](#udmf_fileconflictoptions) | Udmf_FileConflictOptions | 定义文件拷贝冲突时的选项。 | 46| [Udmf_ProgressIndicator](#udmf_progressindicator) | Udmf_ProgressIndicator | 定义进度条指示选项，可选择是否采用系统默认进度显示。 | 47| [Udmf_Visibility](#udmf_visibility) | Udmf_Visibility | 定义数据的可见性等级。 | 48 49### 函数 50 51| 名称 | typedef关键字 | 描述 | 52| -- | -- | -- | 53| [UDMF_KEY_BUFFER_LEN (512)](#udmf_key_buffer_len) | - | 统一数据对象唯一标识符最小空间长度。 | 54| [typedef void (\*OH_Udmf_DataProgressListener)(OH_Udmf_ProgressInfo* progressInfo, OH_UdmfData* data)](#oh_udmf_dataprogresslistener) | OH_Udmf_DataProgressListener | 定义获取进度信息和数据的监听回调函数。<br>使用时需要判断数据是否返回空指针。只有当进度达到100%时，才会返回数据。 | 55| [OH_UdmfData* OH_UdmfData_Create()](#oh_udmfdata_create) | - | 创建统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfData_Destroy](capi-udmf-h.md#oh_udmfdata_destroy)销毁实例对象，否则会导致内存泄漏。 | 56| [void OH_UdmfData_Destroy(OH_UdmfData* pThis)](#oh_udmfdata_destroy) | - | 销毁统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)指针指向的实例对象。 | 57| [int OH_UdmfData_AddRecord(OH_UdmfData* pThis, OH_UdmfRecord* record)](#oh_udmfdata_addrecord) | - | 添加一个数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)到统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中。 | 58| [bool OH_UdmfData_HasType(OH_UdmfData* pThis, const char* type)](#oh_udmfdata_hastype) | - | 检查统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中是否存在指定类型。 | 59| [char** OH_UdmfData_GetTypes(OH_UdmfData* pThis, unsigned int* count)](#oh_udmfdata_gettypes) | - | 获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有类型结果集。 | 60| [OH_UdmfRecord** OH_UdmfData_GetRecords(OH_UdmfData* pThis, unsigned int* count)](#oh_udmfdata_getrecords) | - | 获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有记录结果集。 | 61| [typedef void (\*UdmfData_Finalize)(void* context)](#udmfdata_finalize) | UdmfData_Finalize | 定义用于释放上下文的回调函数，统一数据提供者对象销毁时触发。 | 62| [OH_UdmfRecordProvider* OH_UdmfRecordProvider_Create()](#oh_udmfrecordprovider_create) | - | 创建一个统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfRecordProvider_Destroy](capi-udmf-h.md#oh_udmfrecordprovider_destroy)销毁实例对象，否则会导致内存泄漏。 | 63| [int OH_UdmfRecordProvider_Destroy(OH_UdmfRecordProvider* provider)](#oh_udmfrecordprovider_destroy) | - | 销毁统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)指针指向的实例对象。 | 64| [typedef void* (\*OH_UdmfRecordProvider_GetData)(void* context, const char* type)](#oh_udmfrecordprovider_getdata) | OH_UdmfRecordProvider_GetData | 定义用于按类型获取数据的回调函数。当从OH_UdmfRecord中获取数据时，会触发此回调函数，得到的数据就是这个回调函数返回的数据。 | 65| [int OH_UdmfRecordProvider_SetData(OH_UdmfRecordProvider* provider, void* context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize)](#oh_udmfrecordprovider_setdata) | - | 设置统一数据提供者的数据提供回调函数。 | 66| [OH_UdmfRecord* OH_UdmfRecord_Create()](#oh_udmfrecord_create) | - | 创建统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfRecord_Destroy](capi-udmf-h.md#oh_udmfrecord_destroy)销毁实例对象，否则会导致内存泄漏。 | 67| [void OH_UdmfRecord_Destroy(OH_UdmfRecord* pThis)](#oh_udmfrecord_destroy) | - | 销毁统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)指针指向的实例对象。 | 68| [int OH_UdmfRecord_AddGeneralEntry(OH_UdmfRecord* pThis, const char* typeId, unsigned char* entry, unsigned int count)](#oh_udmfrecord_addgeneralentry) | - | 添加用户自定义的通用数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。对于已定义UDS的类型（比如PlainText、Link、Pixelmap等）不可使用该接口。 | 69| [int OH_UdmfRecord_AddPlainText(OH_UdmfRecord* pThis, OH_UdsPlainText* plainText)](#oh_udmfrecord_addplaintext) | - | 增加纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 70| [int OH_UdmfRecord_AddHyperlink(OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink)](#oh_udmfrecord_addhyperlink) | - | 增加超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 71| [int OH_UdmfRecord_AddHtml(OH_UdmfRecord* pThis, OH_UdsHtml* html)](#oh_udmfrecord_addhtml) | - | 增加超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 72| [int OH_UdmfRecord_AddAppItem(OH_UdmfRecord* pThis, OH_UdsAppItem* appItem)](#oh_udmfrecord_addappitem) | - | 增加桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 73| [int OH_UdmfRecord_AddFileUri(OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri)](#oh_udmfrecord_addfileuri) | - | 增加文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 74| [int OH_UdmfRecord_AddPixelMap(OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap)](#oh_udmfrecord_addpixelmap) | - | 增加像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 75| [int OH_UdmfRecord_AddArrayBuffer(OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer)](#oh_udmfrecord_addarraybuffer) | - | 增加一个ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)的数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 76| [int OH_UdmfRecord_AddContentForm(OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm)](#oh_udmfrecord_addcontentform) | - | 增加一个内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)的数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 77| [char** OH_UdmfRecord_GetTypes(OH_UdmfRecord* pThis, unsigned int* count)](#oh_udmfrecord_gettypes) | - | 获取统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中所有类型的结果集。 | 78| [int OH_UdmfRecord_GetGeneralEntry(OH_UdmfRecord* pThis, const char* typeId, unsigned char** entry, unsigned int* count)](#oh_udmfrecord_getgeneralentry) | - | 获取统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中的特定类型的数据结果集。 | 79| [int OH_UdmfRecord_GetPlainText(OH_UdmfRecord* pThis, OH_UdsPlainText* plainText)](#oh_udmfrecord_getplaintext) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据。 | 80| [int OH_UdmfRecord_GetHyperlink(OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink)](#oh_udmfrecord_gethyperlink) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)数据。 | 81| [int OH_UdmfRecord_GetHtml(OH_UdmfRecord* pThis, OH_UdsHtml* html)](#oh_udmfrecord_gethtml) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据。 | 82| [int OH_UdmfRecord_GetAppItem(OH_UdmfRecord* pThis, OH_UdsAppItem* appItem)](#oh_udmfrecord_getappitem) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)数据。 | 83| [int OH_UdmfRecord_SetProvider(OH_UdmfRecord* pThis, const char* const* types, unsigned int count, OH_UdmfRecordProvider* provider)](#oh_udmfrecord_setprovider) | - | 将指定类型的统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)设置至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 | 84| [int OH_UdmfRecord_GetFileUri(OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri)](#oh_udmfrecord_getfileuri) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)数据。 | 85| [int OH_UdmfRecord_GetPixelMap(OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap)](#oh_udmfrecord_getpixelmap) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)数据。 | 86| [int OH_UdmfRecord_GetArrayBuffer(OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer)](#oh_udmfrecord_getarraybuffer) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)数据。 | 87| [int OH_UdmfRecord_GetContentForm(OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm)](#oh_udmfrecord_getcontentform) | - | 从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)数据。 | 88| [int OH_UdmfData_GetPrimaryPlainText(OH_UdmfData* data, OH_UdsPlainText* plainText)](#oh_udmfdata_getprimaryplaintext) | - | 从统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中获取第一个纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据。 | 89| [int OH_UdmfData_GetPrimaryHtml(OH_UdmfData* data, OH_UdsHtml* html)](#oh_udmfdata_getprimaryhtml) | - | 从统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中获取第一个超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据。 | 90| [int OH_UdmfData_GetRecordCount(OH_UdmfData* data)](#oh_udmfdata_getrecordcount) | - | 获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有记录数量。 | 91| [OH_UdmfRecord* OH_UdmfData_GetRecord(OH_UdmfData* data, unsigned int index)](#oh_udmfdata_getrecord) | - | 获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中指定位置的数据记录。 | 92| [bool OH_UdmfData_IsLocal(OH_UdmfData* data)](#oh_udmfdata_islocal) | - | 检查统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)是否是来自本端设备的数据。 | 93| [OH_UdmfProperty* OH_UdmfProperty_Create(OH_UdmfData* unifiedData)](#oh_udmfproperty_create) | - | 创建统一数据对象中数据记录属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfProperty_Destroy](capi-udmf-h.md#oh_udmfproperty_destroy)销毁实例对象，否则会导致内存泄漏。 | 94| [void OH_UdmfProperty_Destroy(OH_UdmfProperty* pThis)](#oh_udmfproperty_destroy) | - | 销毁数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)指针指向的实例对象。 | 95| [const char* OH_UdmfProperty_GetTag(OH_UdmfProperty* pThis)](#oh_udmfproperty_gettag) | - | 从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取用户自定义标签值。 | 96| [int64_t OH_UdmfProperty_GetTimestamp(OH_UdmfProperty* pThis)](#oh_udmfproperty_gettimestamp) | - | 从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取时间戳。 | 97| [Udmf_ShareOption OH_UdmfProperty_GetShareOption(OH_UdmfProperty* pThis)](#oh_udmfproperty_getshareoption) | - | 从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取设备内适用范围属性。 | 98| [int OH_UdmfProperty_GetExtrasIntParam(OH_UdmfProperty* pThis, const char* key, int defaultValue)](#oh_udmfproperty_getextrasintparam) | - | 从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取自定义的附加整型参数。 | 99| [const char* OH_UdmfProperty_GetExtrasStringParam(OH_UdmfProperty* pThis, const char* key)](#oh_udmfproperty_getextrasstringparam) | - | 从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取自定义的附加字符串参数。 | 100| [int OH_UdmfProperty_SetTag(OH_UdmfProperty* pThis, const char* tag)](#oh_udmfproperty_settag) | - | 设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的自定义标签值。 | 101| [int OH_UdmfProperty_SetShareOption(OH_UdmfProperty* pThis, Udmf_ShareOption option)](#oh_udmfproperty_setshareoption) | - | 设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的设备内适用范围[Udmf_ShareOption](capi-udmf-h.md#udmf_shareoption)参数。 | 102| [int OH_UdmfProperty_SetExtrasIntParam(OH_UdmfProperty* pThis, const char* key, int param)](#oh_udmfproperty_setextrasintparam) | - | 设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的附加整型参数。 | 103| [int OH_UdmfProperty_SetExtrasStringParam(OH_UdmfProperty* pThis, const char* key, const char* param)](#oh_udmfproperty_setextrasstringparam) | - | 设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的附加字符串参数。 | 104| [OH_UdmfOptions* OH_UdmfOptions_Create()](#oh_udmfoptions_create) | - | 创建指向[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 105| [void OH_UdmfOptions_Destroy(OH_UdmfOptions* pThis)](#oh_udmfoptions_destroy) | - | 销毁指向[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 106| [const char* OH_UdmfOptions_GetKey(OH_UdmfOptions* pThis)](#oh_udmfoptions_getkey) | - | 从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据的唯一标识符信息。 | 107| [int OH_UdmfOptions_SetKey(OH_UdmfOptions* pThis, const char* key)](#oh_udmfoptions_setkey) | - | 设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据的唯一标识符内容参数。 | 108| [Udmf_Intention OH_UdmfOptions_GetIntention(OH_UdmfOptions* pThis)](#oh_udmfoptions_getintention) | - | 从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据通路信息。 | 109| [int OH_UdmfOptions_SetIntention(OH_UdmfOptions* pThis, Udmf_Intention intention)](#oh_udmfoptions_setintention) | - | 设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据通路内容参数。 | 110| [int OH_UdmfOptions_Reset(OH_UdmfOptions* pThis)](#oh_udmfoptions_reset) | - | 重置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例为空。 | 111| [int OH_Udmf_GetUnifiedData(const char* key, Udmf_Intention intention, OH_UdmfData* unifiedData)](#oh_udmf_getunifieddata) | - | 从统一数据管理框架数据库中获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 112| [int OH_Udmf_GetUnifiedDataByOptions(OH_UdmfOptions* options, OH_UdmfData** dataArray, unsigned int* dataSize)](#oh_udmf_getunifieddatabyoptions) | - | 通过数据通路类型从统一数据管理框架数据库中获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 113| [int OH_Udmf_SetUnifiedData(Udmf_Intention intention, OH_UdmfData* unifiedData, char* key, unsigned int keyLen)](#oh_udmf_setunifieddata) | - | 从统一数据管理框架数据库中写入统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 114| [int OH_Udmf_SetUnifiedDataByOptions(OH_UdmfOptions* options, OH_UdmfData *unifiedData, char *key, unsigned int keyLen)](#oh_udmf_setunifieddatabyoptions) | - | 从统一数据管理框架数据库中写入统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 115| [int OH_Udmf_UpdateUnifiedData(OH_UdmfOptions* options, OH_UdmfData* unifiedData)](#oh_udmf_updateunifieddata) | - | 对统一数据管理框架数据库中的统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据进行数据更改。 | 116| [int OH_Udmf_DeleteUnifiedData(OH_UdmfOptions* options, OH_UdmfData** dataArray, unsigned int* dataSize)](#oh_udmf_deleteunifieddata) | - | 删除统一数据管理框架数据库中的统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 117| [void OH_Udmf_DestroyDataArray(OH_UdmfData** dataArray, unsigned int dataSize)](#oh_udmf_destroydataarray) | - | 销毁数据数组内存。 | 118| [int OH_UdmfProgressInfo_GetProgress(OH_Udmf_ProgressInfo* progressInfo)](#oh_udmfprogressinfo_getprogress) | - | 从进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)中获取进度百分比数据。 | 119| [int OH_UdmfProgressInfo_GetStatus(OH_Udmf_ProgressInfo* progressInfo)](#oh_udmfprogressinfo_getstatus) | - | 从进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)中获取状态信息。 | 120| [OH_UdmfGetDataParams* OH_UdmfGetDataParams_Create()](#oh_udmfgetdataparams_create) | - | 创建异步获取UDMF数据的请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)指针及实例对象。<br>当不再需要使用指针时，请使用[OH_UdmfGetDataParams_Destroy](capi-udmf-h.md#oh_udmfgetdataparams_destroy)销毁实例对象，否则会导致内存泄漏。 | 121| [void OH_UdmfGetDataParams_Destroy(OH_UdmfGetDataParams* pThis)](#oh_udmfgetdataparams_destroy) | - | 销毁异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)指针指向的实例对象。 | 122| [void OH_UdmfGetDataParams_SetDestUri(OH_UdmfGetDataParams* params, const char* destUri)](#oh_udmfgetdataparams_setdesturi) | - | 设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的目标路径。<br>若设置了目标路径，会将文件类型的数据进行拷贝到指定路径。回调中获取到的文件类型数据会被替换为目标路径的URI。<br>若不设置目标路径，则不会执行拷贝文件操作。回调中获取到的文件类型数据为源端路径URI。<br>若应用涉及复杂文件处理策略，或需要将文件拷贝在多个路径下时，建议不设置此参数，由应用自行完成文件拷贝相关处理。 | 123| [void OH_UdmfGetDataParams_SetFileConflictOptions(OH_UdmfGetDataParams* params, const Udmf_FileConflictOptions options)](#oh_udmfgetdataparams_setfileconflictoptions) | - | 设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的文件冲突选项。 | 124| [void OH_UdmfGetDataParams_SetProgressIndicator(OH_UdmfGetDataParams* params, const Udmf_ProgressIndicator progressIndicator)](#oh_udmfgetdataparams_setprogressindicator) | - | 设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的进度条指示选项。 | 125| [void OH_UdmfGetDataParams_SetDataProgressListener(OH_UdmfGetDataParams* params, const OH_Udmf_DataProgressListener dataProgressListener)](#oh_udmfgetdataparams_setdataprogresslistener) | - | 设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的监听回调函数。 | 126| [Udmf_Visibility OH_UdmfOptions_GetVisibility(OH_UdmfOptions* pThis)](#oh_udmfoptions_getvisibility) | - | 从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据可见性等级。 | 127| [int OH_UdmfOptions_SetVisibility(OH_UdmfOptions* pThis, Udmf_Visibility visibility)](#oh_udmfoptions_setvisibility) | - | 设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据可见性等级。 | 128| [typedef OH_UdmfData* (\*OH_Udmf_DataLoadHandler)(OH_UdmfDataLoadInfo* acceptableInfo)](#oh_udmf_dataloadhandler) | OH_Udmf_DataLoadHandler | 表示用于加载数据的回调函数。 | 129| [OH_UdmfDataLoadParams* OH_UdmfDataLoadParams_Create()](#oh_udmfdataloadparams_create) | - | 创建指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针。 | 130| [void OH_UdmfDataLoadParams_Destroy(OH_UdmfDataLoadParams* pThis)](#oh_udmfdataloadparams_destroy) | - | 销毁数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)指针指向的实例对象。 | 131| [void OH_UdmfDataLoadParams_SetLoadHandler(OH_UdmfDataLoadParams* params, const OH_Udmf_DataLoadHandler dataLoadHandler)](#oh_udmfdataloadparams_setloadhandler) | - | 设置数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)中的数据加载处理函数。 | 132| [void OH_UdmfDataLoadParams_SetDataLoadInfo(OH_UdmfDataLoadParams* params, OH_UdmfDataLoadInfo* dataLoadInfo)](#oh_udmfdataloadparams_setdataloadinfo) | - | 设置数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)中的数据加载信息。 | 133| [OH_UdmfDataLoadInfo* OH_UdmfDataLoadInfo_Create()](#oh_udmfdataloadinfo_create) | - | 创建指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 134| [void OH_UdmfDataLoadInfo_Destroy(OH_UdmfDataLoadInfo* dataLoadInfo)](#oh_udmfdataloadinfo_destroy) | - | 销毁数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)指针指向的实例对象。 | 135| [char** OH_UdmfDataLoadInfo_GetTypes(OH_UdmfDataLoadInfo* dataLoadInfo, unsigned int* count)](#oh_udmfdataloadinfo_gettypes) | - | 从数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中获取数据类型列表。 | 136| [void OH_UdmfDataLoadInfo_SetType(OH_UdmfDataLoadInfo* dataLoadInfo, const char* type)](#oh_udmfdataloadinfo_settype) | - | 设置数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的数据类型。 | 137| [int OH_UdmfDataLoadInfo_GetRecordCount(OH_UdmfDataLoadInfo* dataLoadInfo)](#oh_udmfdataloadinfo_getrecordcount) | - | 获取数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的记录数量。 | 138| [void OH_UdmfDataLoadInfo_SetRecordCount(OH_UdmfDataLoadInfo* dataLoadInfo, unsigned int recordCount)](#oh_udmfdataloadinfo_setrecordcount) | - | 设置数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的记录数量。 | 139 140## 枚举类型说明 141 142### Udmf_Intention 143 144``` 145enum Udmf_Intention 146``` 147 148**描述** 149 150描述UDMF数据通路枚举类型。 151 152**起始版本：** 12 153 154| 枚举项 | 描述 | 155| -- | -- | 156| UDMF_INTENTION_DRAG | 拖拽数据通路。 | 157| UDMF_INTENTION_PASTEBOARD | 剪贴板数据通路。 | 158| UDMF_INTENTION_DATA_HUB | 公共数据通路。<br>**起始版本：** 20 | 159| UDMF_INTENTION_SYSTEM_SHARE | 系统分享数据通路。<br>**起始版本：** 20 | 160| UDMF_INTENTION_PICKER | Picker数据通路。<br>**起始版本：** 20 | 161| UDMF_INTENTION_MENU | 菜单数据通路。<br>**起始版本：** 20 | 162 163### Udmf_ShareOption 164 165``` 166enum Udmf_ShareOption 167``` 168 169**描述** 170 171UDMF支持的设备内使用范围类型枚举。 172 173**起始版本：** 12 174 175| 枚举项 | 描述 | 176| -- | -- | 177| SHARE_OPTIONS_INVALID | 表示不合法的使用范围类型。 | 178| SHARE_OPTIONS_IN_APP | 表示允许在本设备同应用内使用。 | 179| SHARE_OPTIONS_CROSS_APP | 表示允许在本设备内跨应用使用。 | 180 181### Udmf_FileConflictOptions 182 183``` 184enum Udmf_FileConflictOptions 185``` 186 187**描述** 188 189定义文件拷贝冲突时的选项。 190 191**起始版本：** 15 192 193| 枚举项 | 描述 | 194| -- | -- | 195| UDMF_OVERWRITE = 0 | 目标路径存在同文件名时覆盖。若不配置策略，默认使用改策略。 | 196| UDMF_SKIP = 1 | 目标路径存在同文件名时跳过。 | 197 198### Udmf_ProgressIndicator 199 200``` 201enum Udmf_ProgressIndicator 202``` 203 204**描述** 205 206定义进度条指示选项，可选择是否采用系统默认进度显示。 207 208**起始版本：** 15 209 210| 枚举项 | 描述 | 211| -- | -- | 212| UDMF_NONE = 0 | 不采用系统默认进度显示。 | 213| UDMF_DEFAULT = 1 | 采用系统默认进度显示，500ms内获取数据完成将不会拉起默认进度条。 | 214 215### Udmf_Visibility 216 217``` 218enum Udmf_Visibility 219``` 220 221**描述** 222 223定义数据的可见性等级。 224 225**起始版本：** 20 226 227| 枚举项 | 描述 | 228| -- | -- | 229| UDMF_ALL | 可见性等级，所有应用可见。 | 230| UDMF_OWN_PROCESS | 可见性等级，仅数据提供者可见。 | 231 232## 函数说明 233 234### OH_UdmfGetDataParams_SetAcceptableInfo() 235 236``` 237void OH_UdmfGetDataParams_SetAcceptableInfo(OH_UdmfGetDataParams* params, OH_UdmfDataLoadInfo* acceptableInfo) 238``` 239 240**描述** 241 242设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中可接收的数据描述信息。 243 244**起始版本：** 20 245 246 247**参数：** 248 249| 参数项 | 描述 | 250| -- | -- | 251| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* params | 表示指向[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 252| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* acceptableInfo | 表示指向[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 253 254### OH_UdmfDataLoadParams_Create() 255 256``` 257OH_UdmfDataLoadParams* OH_UdmfDataLoadParams_Create() 258``` 259 260**描述** 261 262创建指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针。 263 264**起始版本：** 20 265 266**返回：** 267 268| 类型 | 说明 | 269| -- | -- | 270| [OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)* | 如果创建成功，返回一个指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针；否则返回nullptr。 | 271 272### OH_UdmfDataLoadParams_Destroy() 273 274``` 275void OH_UdmfDataLoadParams_Destroy(OH_UdmfDataLoadParams* pThis) 276``` 277 278**描述** 279 280销毁数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)指针指向的实例对象。 281 282**起始版本：** 20 283 284**参数：** 285 286| 参数项 | 描述 | 287| -- | -- | 288| [OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)* pThis | 表示指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针。 | 289 290### OH_UdmfDataLoadParams_SetLoadHandler() 291 292``` 293void OH_UdmfDataLoadParams_SetLoadHandler(OH_UdmfDataLoadParams* params, const OH_Udmf_DataLoadHandler dataLoadHandler) 294``` 295 296**描述** 297 298设置数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)中的数据加载处理函数。 299 300**起始版本：** 20 301 302**参数：** 303 304| 参数项 | 描述 | 305| -- | -- | 306| [OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)* params | 表示指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针。 | 307| [const OH_Udmf_DataLoadHandler](capi-udmf-h.md#oh_udmf_dataloadhandler) dataLoadHandler | 表示用户定义的数据加载处理函数。 | 308 309### OH_UdmfDataLoadParams_SetDataLoadInfo() 310 311``` 312void OH_UdmfDataLoadParams_SetDataLoadInfo(OH_UdmfDataLoadParams* params, OH_UdmfDataLoadInfo* dataLoadInfo) 313``` 314 315**描述** 316 317设置数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)中的数据加载信息。 318 319**起始版本：** 20 320 321**参数：** 322 323| 参数项 | 描述 | 324| -- | -- | 325| [OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)* params | 表示指向数据加载参数[OH_UdmfDataLoadParams](capi-udmf-oh-udmfdataloadparams.md)实例的指针。 | 326| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 327 328### OH_UdmfDataLoadInfo_Create() 329 330``` 331OH_UdmfDataLoadInfo* OH_UdmfDataLoadInfo_Create() 332``` 333 334**描述** 335 336创建指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 337 338**起始版本：** 20 339 340**返回：** 341 342| 类型 | 说明 | 343| -- | -- | 344| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* | 如果创建成功，返回一个指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针；否则返回nullptr。 | 345 346### OH_UdmfDataLoadInfo_Destroy() 347 348``` 349void OH_UdmfDataLoadInfo_Destroy(OH_UdmfDataLoadInfo* dataLoadInfo) 350``` 351 352**描述** 353 354销毁数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)指针指向的实例对象。 355 356**起始版本：** 20 357 358**参数：** 359 360| 参数项 | 描述 | 361| -- | -- | 362| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 363 364### OH_UdmfDataLoadInfo_GetTypes() 365 366``` 367char** OH_UdmfDataLoadInfo_GetTypes(OH_UdmfDataLoadInfo* dataLoadInfo, unsigned int* count) 368``` 369 370**描述** 371 372从数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中获取数据类型列表。 373 374**起始版本：** 20 375 376**参数：** 377 378| 参数项 | 描述 | 379| -- | -- | 380| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 381| unsigned int* count | 返回的数据类型数量。 | 382 383**返回：** 384 385| 类型 | 说明 | 386| -- | -- | 387| char** | 返回数据类型的字符串数组。 | 388 389### OH_UdmfDataLoadInfo_SetType() 390 391``` 392void OH_UdmfDataLoadInfo_SetType(OH_UdmfDataLoadInfo* dataLoadInfo, const char* type) 393``` 394 395**描述** 396 397设置数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的数据类型。 398 399**起始版本：** 20 400 401**参数：** 402 403| 参数项 | 描述 | 404| -- | -- | 405| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 406| const char* type | 表示数据类型的字符串。 | 407 408### OH_UdmfDataLoadInfo_GetRecordCount() 409 410``` 411int OH_UdmfDataLoadInfo_GetRecordCount(OH_UdmfDataLoadInfo* dataLoadInfo) 412``` 413 414**描述** 415 416获取数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的记录数量。 417 418**起始版本：** 20 419 420**参数：** 421 422| 参数项 | 描述 | 423| -- | -- | 424| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 425 426**返回：** 427 428| 类型 | 说明 | 429| -- | -- | 430| int | 返回记录的数量。 | 431 432### OH_UdmfDataLoadInfo_SetRecordCount() 433 434``` 435void OH_UdmfDataLoadInfo_SetRecordCount(OH_UdmfDataLoadInfo* dataLoadInfo, unsigned int recordCount) 436``` 437 438**描述** 439 440设置数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)中的记录数量。 441 442**起始版本：** 20 443 444**参数：** 445 446| 参数项 | 描述 | 447| -- | -- | 448| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* dataLoadInfo | 表示指向数据加载信息[OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)实例的指针。 | 449| unsigned int recordCount | 表示记录的数量。 | 450 451### OH_Udmf_DataLoadHandler() 452 453``` 454typedef OH_UdmfData* (*OH_Udmf_DataLoadHandler)(OH_UdmfDataLoadInfo* acceptableInfo) 455``` 456 457**描述** 458 459表示用于加载数据的回调函数。 460 461**起始版本：** 20 462 463**参数：** 464 465| 参数项 | 描述 | 466| -- | -- | 467| [OH_UdmfDataLoadInfo](capi-udmf-oh-udmfdataloadinfo.md)* acceptableInfo | 表示接收端可接收的数据类型和数量信息。 | 468 469**返回：** 470 471| 类型 | 说明 | 472| -- | -- | 473| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* (*OH_Udmf_DataLoadHandler) | 返回待加载的数据。 | 474 475### OH_UdmfOptions_GetVisibility() 476 477``` 478Udmf_Visibility OH_UdmfOptions_GetVisibility(OH_UdmfOptions* pThis) 479``` 480 481**描述** 482 483从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据可见性等级。 484 485**起始版本：** 20 486 487**参数：** 488 489| 参数项 | 描述 | 490| -- | -- | 491| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 492 493**返回：** 494 495| 类型 | 说明 | 496| -- | -- | 497| [Udmf_Visibility](capi-udmf-h.md#udmf_visibility) | 返回数据可见性等级[Udmf_Visibility](capi-udmf-h.md#udmf_visibility)的值。 | 498 499### OH_UdmfOptions_SetVisibility() 500 501``` 502int OH_UdmfOptions_SetVisibility(OH_UdmfOptions* pThis, Udmf_Visibility visibility) 503``` 504 505**描述** 506 507设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据可见性等级。 508 509**起始版本：** 20 510 511**参数：** 512 513| 参数项 | 描述 | 514| -- | -- | 515| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 516| [Udmf_Visibility](capi-udmf-h.md#udmf_visibility) visibility | 数据可见性等级[Udmf_Visibility](capi-udmf-h.md#udmf_visibility)参数。 | 517 518**返回：** 519 520| 类型 | 说明 | 521| -- | -- | 522| int | 返回执行结果。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br> 若返回UDMF_E_OK，表示执行成功。<br> 若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 523 524### UDMF_KEY_BUFFER_LEN() 525 526``` 527UDMF_KEY_BUFFER_LEN (512) 528``` 529 530**描述** 531 532统一数据对象唯一标识符最小空间长度。 533 534**起始版本：** 12 535 536### OH_Udmf_DataProgressListener() 537 538``` 539typedef void (*OH_Udmf_DataProgressListener)(OH_Udmf_ProgressInfo* progressInfo, OH_UdmfData* data) 540``` 541 542**描述** 543 544定义获取进度信息和数据的监听回调函数。<br>使用时需要判断数据是否返回空指针。只有当进度达到100%时，才会返回数据。 545 546**起始版本：** 15 547 548 549**参数：** 550 551| 参数项 | 描述 | 552| -- | -- | 553| [OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)* progressInfo | 进度信息，作为出参使用。 | 554| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 返回的统一数据对象，作为出参使用。 | 555 556### OH_UdmfData_Create() 557 558``` 559OH_UdmfData* OH_UdmfData_Create() 560``` 561 562**描述** 563 564创建统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfData_Destroy](capi-udmf-h.md#oh_udmfdata_destroy)销毁实例对象，否则会导致内存泄漏。 565 566**起始版本：** 12 567 568**返回：** 569 570| 类型 | 说明 | 571| -- | -- | 572| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* | 执行成功则返回一个指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例对象的指针，否则返回nullptr。 | 573 574**参考：** 575 576OH_UdmfData 577 578### OH_UdmfData_Destroy() 579 580``` 581void OH_UdmfData_Destroy(OH_UdmfData* pThis) 582``` 583 584**描述** 585 586销毁统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)指针指向的实例对象。 587 588**起始版本：** 12 589 590 591**参数：** 592 593| 参数项 | 描述 | 594| -- | -- | 595| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* pThis | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 596 597**参考：** 598 599OH_UdmfData 600 601### OH_UdmfData_AddRecord() 602 603``` 604int OH_UdmfData_AddRecord(OH_UdmfData* pThis, OH_UdmfRecord* record) 605``` 606 607**描述** 608 609添加一个数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)到统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中。 610 611**起始版本：** 12 612 613 614**参数：** 615 616| 参数项 | 描述 | 617| -- | -- | 618| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* pThis | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 619| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* record | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 620 621**返回：** 622 623| 类型 | 说明 | 624| -- | -- | 625| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 626 627### OH_UdmfData_HasType() 628 629``` 630bool OH_UdmfData_HasType(OH_UdmfData* pThis, const char* type) 631``` 632 633**描述** 634 635检查统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中是否存在指定类型。 636 637**起始版本：** 12 638 639 640**参数：** 641 642| 参数项 | 描述 | 643| -- | -- | 644| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* pThis | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 645| const char* type | 表示指定类型的字符串指针。 | 646 647**返回：** 648 649| 类型 | 说明 | 650| -- | -- | 651| bool | 返回查找类型的状态。返回false表示不存在指定类型，返回true表示存在指定类型。 | 652 653### OH_UdmfData_GetTypes() 654 655``` 656char** OH_UdmfData_GetTypes(OH_UdmfData* pThis, unsigned int* count) 657``` 658 659**描述** 660 661获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有类型结果集。 662 663**起始版本：** 12 664 665 666**参数：** 667 668| 参数项 | 描述 | 669| -- | -- | 670| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* pThis | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 671| unsigned int* count | 该参数是输出参数，结果集中的类型数量会写入该变量。 | 672 673**返回：** 674 675| 类型 | 说明 | 676| -- | -- | 677| char** | 执行成功时返回统一数据对象的类型结果集，否则返回nullptr。 | 678 679### OH_UdmfData_GetRecords() 680 681``` 682OH_UdmfRecord** OH_UdmfData_GetRecords(OH_UdmfData* pThis, unsigned int* count) 683``` 684 685**描述** 686 687获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有记录结果集。 688 689**起始版本：** 12 690 691 692**参数：** 693 694| 参数项 | 描述 | 695| -- | -- | 696| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* pThis | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 697| unsigned int* count | 该参数是输出参数，结果集中的记录数量会写入该变量。 | 698 699**返回：** 700 701| 类型 | 说明 | 702| -- | -- | 703| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)** | 执行成功时返回统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)结果集，否则返回nullptr。 | 704 705### UdmfData_Finalize() 706 707``` 708typedef void (*UdmfData_Finalize)(void* context) 709``` 710 711**描述** 712 713定义用于释放上下文的回调函数，统一数据提供者对象销毁时触发。 714 715**起始版本：** 13 716 717**参数：** 718 719| 参数项 | 描述 | 720| -- | -- | 721| void* context | 要释放的上下文指针。 | 722 723### OH_UdmfRecordProvider_Create() 724 725``` 726OH_UdmfRecordProvider* OH_UdmfRecordProvider_Create() 727``` 728 729**描述** 730 731创建一个统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfRecordProvider_Destroy](capi-udmf-h.md#oh_udmfrecordprovider_destroy)销毁实例对象，否则会导致内存泄漏。 732 733**起始版本：** 13 734 735**返回：** 736 737| 类型 | 说明 | 738| -- | -- | 739| [OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)* | 执行成功时返回一个指向统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)实例对象的指针，否则返回nullptr。 | 740 741### OH_UdmfRecordProvider_Destroy() 742 743``` 744int OH_UdmfRecordProvider_Destroy(OH_UdmfRecordProvider* provider) 745``` 746 747**描述** 748 749销毁统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)指针指向的实例对象。 750 751**起始版本：** 13 752 753 754**参数：** 755 756| 参数项 | 描述 | 757| -- | -- | 758| [OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)* provider | 表示指向统一数据提供者对象[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)实例的指针。 | 759 760**返回：** 761 762| 类型 | 说明 | 763| -- | -- | 764| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 765 766### OH_UdmfRecordProvider_GetData() 767 768``` 769typedef void* (*OH_UdmfRecordProvider_GetData)(void* context, const char* type) 770``` 771 772**描述** 773 774定义用于按类型获取数据的回调函数。当从OH_UdmfRecord中获取数据时，会触发此回调函数，得到的数据就是这个回调函数返回的数据。 775 776**起始版本：** 13 777 778 779**参数：** 780 781| 参数项 | 描述 | 782| -- | -- | 783| void* context | 用[OH_UdmfRecordProvider_SetData](capi-udmf-h.md#oh_udmfrecordprovider_setdata)设置的上下文指针。 | 784| const char* type | 要获取的数据类型。详细类型信息见[udmf_meta.h](capi-udmf-meta-h.md)。 | 785 786**返回：** 787 788| 类型 | 说明 | 789| -- | -- | 790| void* | 需要返回一个标准化数据。 | 791 792### OH_UdmfRecordProvider_SetData() 793 794``` 795int OH_UdmfRecordProvider_SetData(OH_UdmfRecordProvider* provider, void* context, const OH_UdmfRecordProvider_GetData callback, const UdmfData_Finalize finalize) 796``` 797 798**描述** 799 800设置统一数据提供者的数据提供回调函数。 801 802**起始版本：** 13 803 804 805**参数：** 806 807| 参数项 | 描述 | 808| -- | -- | 809| [OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)* provider | 指向统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)实例对象的指针。 | 810| void* context | 上下文指针，将作为第一个参数传入[OH_UdmfRecordProvider_GetData](capi-udmf-h.md#oh_udmfrecordprovider_getdata)。 | 811| const [OH_UdmfRecordProvider_GetData](#oh_udmfrecordprovider_getdata) callback | 获取数据的回调函数。详见：[OH_UdmfRecordProvider_GetData](capi-udmf-h.md#oh_udmfrecordprovider_getdata)。 | 812| const [UdmfData_Finalize](#udmfdata_finalize) finalize | 可选的回调函数，可以用于统一数据提供者销毁时释放上下文数据。详见：[UdmfData_Finalize](capi-udmf-h.md#udmfdata_finalize)。 | 813 814**返回：** 815 816| 类型 | 说明 | 817| -- | -- | 818| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 819 820### OH_UdmfRecord_Create() 821 822``` 823OH_UdmfRecord* OH_UdmfRecord_Create() 824``` 825 826**描述** 827 828创建统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfRecord_Destroy](capi-udmf-h.md#oh_udmfrecord_destroy)销毁实例对象，否则会导致内存泄漏。 829 830**起始版本：** 12 831 832**返回：** 833 834| 类型 | 说明 | 835| -- | -- | 836| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* | 执行成功则返回一个指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例对象的指针，否则返回nullptr。 | 837 838### OH_UdmfRecord_Destroy() 839 840``` 841void OH_UdmfRecord_Destroy(OH_UdmfRecord* pThis) 842``` 843 844**描述** 845 846销毁统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)指针指向的实例对象。 847 848**起始版本：** 12 849 850 851**参数：** 852 853| 参数项 | 描述 | 854| -- | -- | 855| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据对象[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 856 857### OH_UdmfRecord_AddGeneralEntry() 858 859``` 860int OH_UdmfRecord_AddGeneralEntry(OH_UdmfRecord* pThis, const char* typeId, unsigned char* entry, unsigned int count) 861``` 862 863**描述** 864 865添加用户自定义的通用数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。对于已定义UDS的类型（比如PlainText、Link、Pixelmap等）不可使用该接口。 866 867**起始版本：** 12 868 869 870**参数：** 871 872| 参数项 | 描述 | 873| -- | -- | 874| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 875| const char* typeId | 表示数据类型标识，为和系统定义的类型进行区分，建议以'ApplicationDefined'开头。 | 876| unsigned char* entry | 表示用户自定义数据。 | 877| unsigned int count | 表示用户自定义数据的大小。数据大小不超过4KB。 | 878 879**返回：** 880 881| 类型 | 说明 | 882| -- | -- | 883| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 884 885### OH_UdmfRecord_AddPlainText() 886 887``` 888int OH_UdmfRecord_AddPlainText(OH_UdmfRecord* pThis, OH_UdsPlainText* plainText) 889``` 890 891**描述** 892 893增加纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 894 895**起始版本：** 12 896 897 898**参数：** 899 900| 参数项 | 描述 | 901| -- | -- | 902| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 903| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* plainText | 表示指向纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)实例的指针。 | 904 905**返回：** 906 907| 类型 | 说明 | 908| -- | -- | 909| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 910 911### OH_UdmfRecord_AddHyperlink() 912 913``` 914int OH_UdmfRecord_AddHyperlink(OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink) 915``` 916 917**描述** 918 919增加超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 920 921**起始版本：** 12 922 923 924**参数：** 925 926| 参数项 | 描述 | 927| -- | -- | 928| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 929| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* hyperlink | 表示指向超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)实例的指针。 | 930 931**返回：** 932 933| 类型 | 说明 | 934| -- | -- | 935| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 936 937### OH_UdmfRecord_AddHtml() 938 939``` 940int OH_UdmfRecord_AddHtml(OH_UdmfRecord* pThis, OH_UdsHtml* html) 941``` 942 943**描述** 944 945增加超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 946 947**起始版本：** 12 948 949 950**参数：** 951 952| 参数项 | 描述 | 953| -- | -- | 954| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 955| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* html | 表示指向超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)实例的指针。 | 956 957**返回：** 958 959| 类型 | 说明 | 960| -- | -- | 961| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 962 963### OH_UdmfRecord_AddAppItem() 964 965``` 966int OH_UdmfRecord_AddAppItem(OH_UdmfRecord* pThis, OH_UdsAppItem* appItem) 967``` 968 969**描述** 970 971增加桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 972 973**起始版本：** 12 974 975 976**参数：** 977 978| 参数项 | 描述 | 979| -- | -- | 980| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 981| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* appItem | 表示指向桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)实例的指针。 | 982 983**返回：** 984 985| 类型 | 说明 | 986| -- | -- | 987| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 988 989### OH_UdmfRecord_AddFileUri() 990 991``` 992int OH_UdmfRecord_AddFileUri(OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri) 993``` 994 995**描述** 996 997增加文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 998 999**起始版本：** 13 1000 1001 1002**参数：** 1003 1004| 参数项 | 描述 | 1005| -- | -- | 1006| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1007| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* fileUri | 表示指向文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)实例的指针。 | 1008 1009**返回：** 1010 1011| 类型 | 说明 | 1012| -- | -- | 1013| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1014 1015### OH_UdmfRecord_AddPixelMap() 1016 1017``` 1018int OH_UdmfRecord_AddPixelMap(OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap) 1019``` 1020 1021**描述** 1022 1023增加像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 1024 1025**起始版本：** 13 1026 1027 1028**参数：** 1029 1030| 参数项 | 描述 | 1031| -- | -- | 1032| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1033| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pixelMap | 表示指向像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)实例的指针。 | 1034 1035**返回：** 1036 1037| 类型 | 说明 | 1038| -- | -- | 1039| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1040 1041### OH_UdmfRecord_AddArrayBuffer() 1042 1043``` 1044int OH_UdmfRecord_AddArrayBuffer(OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer) 1045``` 1046 1047**描述** 1048 1049增加一个ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)的数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 1050 1051**起始版本：** 13 1052 1053 1054**参数：** 1055 1056| 参数项 | 描述 | 1057| -- | -- | 1058| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* record | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1059| const char* type | 表示自定义的ArrayBuffer数据的数据类型标识，不可与已有的数据类型标识重复。 | 1060| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* buffer | 表示指向ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)实例的指针。 | 1061 1062**返回：** 1063 1064| 类型 | 说明 | 1065| -- | -- | 1066| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1067 1068### OH_UdmfRecord_AddContentForm() 1069 1070``` 1071int OH_UdmfRecord_AddContentForm(OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm) 1072``` 1073 1074**描述** 1075 1076增加一个内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)的数据至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 1077 1078**起始版本：** 14 1079 1080 1081**参数：** 1082 1083| 参数项 | 描述 | 1084| -- | -- | 1085| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1086| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* contentForm | 表示指向内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)实例的指针。 | 1087 1088**返回：** 1089 1090| 类型 | 说明 | 1091| -- | -- | 1092| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1093 1094### OH_UdmfRecord_GetTypes() 1095 1096``` 1097char** OH_UdmfRecord_GetTypes(OH_UdmfRecord* pThis, unsigned int* count) 1098``` 1099 1100**描述** 1101 1102获取统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中所有类型的结果集。 1103 1104**起始版本：** 12 1105 1106 1107**参数：** 1108 1109| 参数项 | 描述 | 1110| -- | -- | 1111| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1112| unsigned int* count | 该参数是输出参数，结果集中的类型数量会写入该变量。 | 1113 1114**返回：** 1115 1116| 类型 | 说明 | 1117| -- | -- | 1118| char** | 执行成功时返回类型列表，否则返回nullptr。 | 1119 1120### OH_UdmfRecord_GetGeneralEntry() 1121 1122``` 1123int OH_UdmfRecord_GetGeneralEntry(OH_UdmfRecord* pThis, const char* typeId, unsigned char** entry, unsigned int* count) 1124``` 1125 1126**描述** 1127 1128获取统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中的特定类型的数据结果集。 1129 1130**起始版本：** 12 1131 1132 1133**参数：** 1134 1135| 参数项 | 描述 | 1136| -- | -- | 1137| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1138| const char* typeId | 表示数据类型标识。 | 1139| unsigned char** entry | 该参数是输出参数，结果集中数据的具体信息会写入该变量。 | 1140| unsigned int* count | 该参数是输出参数，结果集中的数据长度会写入该变量。 | 1141 1142**返回：** 1143 1144| 类型 | 说明 | 1145| -- | -- | 1146| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1147 1148### OH_UdmfRecord_GetPlainText() 1149 1150``` 1151int OH_UdmfRecord_GetPlainText(OH_UdmfRecord* pThis, OH_UdsPlainText* plainText) 1152``` 1153 1154**描述** 1155 1156从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据。 1157 1158**起始版本：** 12 1159 1160 1161**参数：** 1162 1163| 参数项 | 描述 | 1164| -- | -- | 1165| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1166| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* plainText | 该参数是输出参数，表示指向纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)实例的指针。 | 1167 1168**返回：** 1169 1170| 类型 | 说明 | 1171| -- | -- | 1172| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1173 1174### OH_UdmfRecord_GetHyperlink() 1175 1176``` 1177int OH_UdmfRecord_GetHyperlink(OH_UdmfRecord* pThis, OH_UdsHyperlink* hyperlink) 1178``` 1179 1180**描述** 1181 1182从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)数据。 1183 1184**起始版本：** 12 1185 1186 1187**参数：** 1188 1189| 参数项 | 描述 | 1190| -- | -- | 1191| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1192| [OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)* hyperlink | 该参数是输出参数，表示指向超链接类型[OH_UdsHyperlink](capi-udmf-oh-udshyperlink.md)实例的指针。 | 1193 1194**返回：** 1195 1196| 类型 | 说明 | 1197| -- | -- | 1198| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1199 1200### OH_UdmfRecord_GetHtml() 1201 1202``` 1203int OH_UdmfRecord_GetHtml(OH_UdmfRecord* pThis, OH_UdsHtml* html) 1204``` 1205 1206**描述** 1207 1208从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据。 1209 1210**起始版本：** 12 1211 1212 1213**参数：** 1214 1215| 参数项 | 描述 | 1216| -- | -- | 1217| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1218| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* html | 该参数是输出参数，表示指向超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)实例的指针。 | 1219 1220**返回：** 1221 1222| 类型 | 说明 | 1223| -- | -- | 1224| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1225 1226### OH_UdmfRecord_GetAppItem() 1227 1228``` 1229int OH_UdmfRecord_GetAppItem(OH_UdmfRecord* pThis, OH_UdsAppItem* appItem) 1230``` 1231 1232**描述** 1233 1234从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)数据。 1235 1236**起始版本：** 12 1237 1238 1239**参数：** 1240 1241| 参数项 | 描述 | 1242| -- | -- | 1243| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1244| [OH_UdsAppItem](capi-udmf-oh-udsappitem.md)* appItem | 该参数是输出参数，表示指向桌面图标类型[OH_UdsAppItem](capi-udmf-oh-udsappitem.md)实例的指针。 | 1245 1246**返回：** 1247 1248| 类型 | 说明 | 1249| -- | -- | 1250| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1251 1252### OH_UdmfRecord_SetProvider() 1253 1254``` 1255int OH_UdmfRecord_SetProvider(OH_UdmfRecord* pThis, const char* const* types, unsigned int count, OH_UdmfRecordProvider* provider) 1256``` 1257 1258**描述** 1259 1260将指定类型的统一数据提供者[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)设置至统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中。 1261 1262**起始版本：** 13 1263 1264 1265**参数：** 1266 1267| 参数项 | 描述 | 1268| -- | -- | 1269| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1270| const char* const* types | 表示一组指定的要提供的数据类型。 | 1271| unsigned int count | 表示指定的数据类型的数量。 | 1272| [OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)* provider | 表示指向统一数据提供者对象[OH_UdmfRecordProvider](capi-udmf-oh-udmfrecordprovider.md)实例的指针。 | 1273 1274**返回：** 1275 1276| 类型 | 说明 | 1277| -- | -- | 1278| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1279 1280### OH_UdmfRecord_GetFileUri() 1281 1282``` 1283int OH_UdmfRecord_GetFileUri(OH_UdmfRecord* pThis, OH_UdsFileUri* fileUri) 1284``` 1285 1286**描述** 1287 1288从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)数据。 1289 1290**起始版本：** 13 1291 1292 1293**参数：** 1294 1295| 参数项 | 描述 | 1296| -- | -- | 1297| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1298| [OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)* fileUri | 该参数是输出参数，表示指向文件Uri类型[OH_UdsFileUri](capi-udmf-oh-udsfileuri.md)实例的指针。 | 1299 1300**返回：** 1301 1302| 类型 | 说明 | 1303| -- | -- | 1304| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1305 1306### OH_UdmfRecord_GetPixelMap() 1307 1308``` 1309int OH_UdmfRecord_GetPixelMap(OH_UdmfRecord* pThis, OH_UdsPixelMap* pixelMap) 1310``` 1311 1312**描述** 1313 1314从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)数据。 1315 1316**起始版本：** 13 1317 1318 1319**参数：** 1320 1321| 参数项 | 描述 | 1322| -- | -- | 1323| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1324| [OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)* pixelMap | 该参数是输出参数，表示指向像素图片类型[OH_UdsPixelMap](capi-udmf-oh-udspixelmap.md)实例的指针。 | 1325 1326**返回：** 1327 1328| 类型 | 说明 | 1329| -- | -- | 1330| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1331 1332### OH_UdmfRecord_GetArrayBuffer() 1333 1334``` 1335int OH_UdmfRecord_GetArrayBuffer(OH_UdmfRecord* record, const char* type, OH_UdsArrayBuffer* buffer) 1336``` 1337 1338**描述** 1339 1340从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)数据。 1341 1342**起始版本：** 13 1343 1344 1345**参数：** 1346 1347| 参数项 | 描述 | 1348| -- | -- | 1349| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* record | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1350| const char* type | 表示要获取的ArrayBuffer类型数据的数据类型标识。 | 1351| [OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)* buffer | 该参数是输出参数，表示指向ArrayBuffer类型[OH_UdsArrayBuffer](capi-udmf-oh-udsarraybuffer.md)实例的指针。 | 1352 1353**返回：** 1354 1355| 类型 | 说明 | 1356| -- | -- | 1357| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1358 1359### OH_UdmfRecord_GetContentForm() 1360 1361``` 1362int OH_UdmfRecord_GetContentForm(OH_UdmfRecord* pThis, OH_UdsContentForm* contentForm) 1363``` 1364 1365**描述** 1366 1367从统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)中获取内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)数据。 1368 1369**起始版本：** 14 1370 1371 1372**参数：** 1373 1374| 参数项 | 描述 | 1375| -- | -- | 1376| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* pThis | 表示指向统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1377| [OH_UdsContentForm](capi-udmf-oh-udscontentform.md)* contentForm | 该参数是输出参数，表示指向内容卡片类型[OH_UdsContentForm](capi-udmf-oh-udscontentform.md)实例的指针。 | 1378 1379**返回：** 1380 1381| 类型 | 说明 | 1382| -- | -- | 1383| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1384 1385### OH_UdmfData_GetPrimaryPlainText() 1386 1387``` 1388int OH_UdmfData_GetPrimaryPlainText(OH_UdmfData* data, OH_UdsPlainText* plainText) 1389``` 1390 1391**描述** 1392 1393从统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中获取第一个纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)数据。 1394 1395**起始版本：** 13 1396 1397 1398**参数：** 1399 1400| 参数项 | 描述 | 1401| -- | -- | 1402| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 1403| [OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)* plainText | 该参数是输出参数，表示指向纯文本类型[OH_UdsPlainText](capi-udmf-oh-udsplaintext.md)实例的指针。 | 1404 1405**返回：** 1406 1407| 类型 | 说明 | 1408| -- | -- | 1409| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1410 1411### OH_UdmfData_GetPrimaryHtml() 1412 1413``` 1414int OH_UdmfData_GetPrimaryHtml(OH_UdmfData* data, OH_UdsHtml* html) 1415``` 1416 1417**描述** 1418 1419从统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中获取第一个超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)数据。 1420 1421**起始版本：** 13 1422 1423 1424**参数：** 1425 1426| 参数项 | 描述 | 1427| -- | -- | 1428| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 1429| [OH_UdsHtml](capi-udmf-oh-udshtml.md)* html | 该参数是输出参数，表示指向超文本标记语言类型[OH_UdsHtml](capi-udmf-oh-udshtml.md)实例的指针。 | 1430 1431**返回：** 1432 1433| 类型 | 说明 | 1434| -- | -- | 1435| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1436 1437### OH_UdmfData_GetRecordCount() 1438 1439``` 1440int OH_UdmfData_GetRecordCount(OH_UdmfData* data) 1441``` 1442 1443**描述** 1444 1445获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中包含的所有记录数量。 1446 1447**起始版本：** 13 1448 1449 1450**参数：** 1451 1452| 参数项 | 描述 | 1453| -- | -- | 1454| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。| 1455 1456**返回：** 1457 1458| 类型 | 说明 | 1459| -- | -- | 1460| int | 返回统一数据对象[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)的数量。 | 1461 1462### OH_UdmfData_GetRecord() 1463 1464``` 1465OH_UdmfRecord* OH_UdmfData_GetRecord(OH_UdmfData* data, unsigned int index) 1466``` 1467 1468**描述** 1469 1470获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中指定位置的数据记录。 1471 1472**起始版本：** 13 1473 1474 1475**参数：** 1476 1477| 参数项 | 描述 | 1478| -- | -- | 1479| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 1480| unsigned int index | 表示要获取的统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)在统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)中的下标。 | 1481 1482**返回：** 1483 1484| 类型 | 说明 | 1485| -- | -- | 1486| [OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)* | 执行成功时返回统一数据记录[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例对象的指针，否则返回nullptr。 | 1487 1488### OH_UdmfData_IsLocal() 1489 1490``` 1491bool OH_UdmfData_IsLocal(OH_UdmfData* data) 1492``` 1493 1494**描述** 1495 1496检查统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)是否是来自本端设备的数据。 1497 1498**起始版本：** 13 1499 1500 1501**参数：** 1502 1503| 参数项 | 描述 | 1504| -- | -- | 1505| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* data | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 1506 1507**返回：** 1508 1509| 类型 | 说明 | 1510| -- | -- | 1511| bool | 返回数据是否是来自本端设备。返回true表示来自本端设备，返回false表示来自远端设备。 | 1512 1513### OH_UdmfProperty_Create() 1514 1515``` 1516OH_UdmfProperty* OH_UdmfProperty_Create(OH_UdmfData* unifiedData) 1517``` 1518 1519**描述** 1520 1521创建统一数据对象中数据记录属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)指针及实例对象。当不再需要使用指针时，请使用[OH_UdmfProperty_Destroy](capi-udmf-h.md#oh_udmfproperty_destroy)销毁实例对象，否则会导致内存泄漏。 1522 1523**起始版本：** 12 1524 1525 1526**参数：** 1527 1528| 参数项 | 描述 | 1529| -- | -- | 1530| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* unifiedData | 表示指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 1531 1532**返回：** 1533 1534| 类型 | 说明 | 1535| -- | -- | 1536| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* | 执行成功则返回一个指向属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例对象的指针，否则返回nullptr。 | 1537 1538### OH_UdmfProperty_Destroy() 1539 1540``` 1541void OH_UdmfProperty_Destroy(OH_UdmfProperty* pThis) 1542``` 1543 1544**描述** 1545 1546销毁数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)指针指向的实例对象。 1547 1548**起始版本：** 12 1549 1550 1551**参数：** 1552 1553| 参数项 | 描述 | 1554| -- | -- | 1555| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1556 1557### OH_UdmfProperty_GetTag() 1558 1559``` 1560const char* OH_UdmfProperty_GetTag(OH_UdmfProperty* pThis) 1561``` 1562 1563**描述** 1564 1565从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取用户自定义标签值。 1566 1567**起始版本：** 12 1568 1569 1570**参数：** 1571 1572| 参数项 | 描述 | 1573| -- | -- | 1574| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1575 1576**返回：** 1577 1578| 类型 | 说明 | 1579| -- | -- | 1580| const char* | 执行成功时返回自定义标签值的字符串指针，否则返回nullptr。 | 1581 1582### OH_UdmfProperty_GetTimestamp() 1583 1584``` 1585int64_t OH_UdmfProperty_GetTimestamp(OH_UdmfProperty* pThis) 1586``` 1587 1588**描述** 1589 1590从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取时间戳。 1591 1592**起始版本：** 12 1593 1594 1595**参数：** 1596 1597| 参数项 | 描述 | 1598| -- | -- | 1599| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1600 1601**返回：** 1602 1603| 类型 | 说明 | 1604| -- | -- | 1605| int64_t | 返回时间戳值。 | 1606 1607### OH_UdmfProperty_GetShareOption() 1608 1609``` 1610Udmf_ShareOption OH_UdmfProperty_GetShareOption(OH_UdmfProperty* pThis) 1611``` 1612 1613**描述** 1614 1615从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取设备内适用范围属性。 1616 1617**起始版本：** 12 1618 1619 1620**参数：** 1621 1622| 参数项 | 描述 | 1623| -- | -- | 1624| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1625 1626**返回：** 1627 1628| 类型 | 说明 | 1629| -- | -- | 1630| [Udmf_ShareOption](#udmf_shareoption) | 返回设备内适用范围属性[Udmf_ShareOption](capi-udmf-h.md#udmf_shareoption)值。 | 1631 1632### OH_UdmfProperty_GetExtrasIntParam() 1633 1634``` 1635int OH_UdmfProperty_GetExtrasIntParam(OH_UdmfProperty* pThis, const char* key, int defaultValue) 1636``` 1637 1638**描述** 1639 1640从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取自定义的附加整型参数。 1641 1642**起始版本：** 12 1643 1644 1645**参数：** 1646 1647| 参数项 | 描述 | 1648| -- | -- | 1649| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1650| const char* key | 表示键值对的键。 | 1651| int defaultValue | 用于用户自行设置获取值失败时的默认值。 | 1652 1653**返回：** 1654 1655| 类型 | 说明 | 1656| -- | -- | 1657| int | 执行成功返回指定的键关联的整型值，否则返回用户设置的默认值defaultValue。 | 1658 1659### OH_UdmfProperty_GetExtrasStringParam() 1660 1661``` 1662const char* OH_UdmfProperty_GetExtrasStringParam(OH_UdmfProperty* pThis, const char* key) 1663``` 1664 1665**描述** 1666 1667从数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)中获取自定义的附加字符串参数。 1668 1669**起始版本：** 12 1670 1671 1672**参数：** 1673 1674| 参数项 | 描述 | 1675| -- | -- | 1676| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1677| const char* key | 表示键值对的键。 | 1678 1679**返回：** 1680 1681| 类型 | 说明 | 1682| -- | -- | 1683| const char* | 执行成功时返回指定的键关联的字符串值的指针，否则返回nullptr。 | 1684 1685### OH_UdmfProperty_SetTag() 1686 1687``` 1688int OH_UdmfProperty_SetTag(OH_UdmfProperty* pThis, const char* tag) 1689``` 1690 1691**描述** 1692 1693设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的自定义标签值。 1694 1695**起始版本：** 12 1696 1697 1698**参数：** 1699 1700| 参数项 | 描述 | 1701| -- | -- | 1702| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1703| const char* tag | 表示自定义标签值。 | 1704 1705**返回：** 1706 1707| 类型 | 说明 | 1708| -- | -- | 1709| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1710 1711### OH_UdmfProperty_SetShareOption() 1712 1713``` 1714int OH_UdmfProperty_SetShareOption(OH_UdmfProperty* pThis, Udmf_ShareOption option) 1715``` 1716 1717**描述** 1718 1719设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的设备内适用范围[Udmf_ShareOption](capi-udmf-h.md#udmf_shareoption)参数。 1720 1721**起始版本：** 12 1722 1723 1724**参数：** 1725 1726| 参数项 | 描述 | 1727| -- | -- | 1728| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)实例的指针。 | 1729| [Udmf_ShareOption](#udmf_shareoption) option | 表示设备内适用范围[Udmf_ShareOption](capi-udmf-h.md#udmf_shareoption)参数。 | 1730 1731**返回：** 1732 1733| 类型 | 说明 | 1734| -- | -- | 1735| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1736 1737### OH_UdmfProperty_SetExtrasIntParam() 1738 1739``` 1740int OH_UdmfProperty_SetExtrasIntParam(OH_UdmfProperty* pThis, const char* key, int param) 1741``` 1742 1743**描述** 1744 1745设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的附加整型参数。 1746 1747**起始版本：** 12 1748 1749 1750**参数：** 1751 1752| 参数项 | 描述 | 1753| -- | -- | 1754| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1755| const char* key | 表示键值对的键。 | 1756| int param | 表示键值对的值。 | 1757 1758**返回：** 1759 1760| 类型 | 说明 | 1761| -- | -- | 1762| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1763 1764### OH_UdmfProperty_SetExtrasStringParam() 1765 1766``` 1767int OH_UdmfProperty_SetExtrasStringParam(OH_UdmfProperty* pThis, const char* key, const char* param) 1768``` 1769 1770**描述** 1771 1772设置数据属性[OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)的附加字符串参数。 1773 1774**起始版本：** 12 1775 1776 1777**参数：** 1778 1779| 参数项 | 描述 | 1780| -- | -- | 1781| [OH_UdmfProperty](capi-udmf-oh-udmfproperty.md)* pThis | 表示指向数据属性[OH_UdmfRecord](capi-udmf-oh-udmfrecord.md)实例的指针。 | 1782| const char* key | 表示键值对的键。 | 1783| const char* param | 表示键值对的值。 | 1784 1785**返回：** 1786 1787| 类型 | 说明 | 1788| -- | -- | 1789| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1790 1791### OH_UdmfOptions_Create() 1792 1793``` 1794OH_UdmfOptions* OH_UdmfOptions_Create() 1795``` 1796 1797**描述** 1798 1799创建指向[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 1800 1801**起始版本：** 20 1802 1803**返回：** 1804 1805| 类型 | 说明 | 1806| -- | -- | 1807| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* | 执行成功则返回一个指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针，否则返回nullptr。 | 1808 1809### OH_UdmfOptions_Destroy() 1810 1811``` 1812void OH_UdmfOptions_Destroy(OH_UdmfOptions* pThis) 1813``` 1814 1815**描述** 1816 1817销毁指向[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 1818 1819**起始版本：** 20 1820 1821 1822**参数：** 1823 1824| 参数项 | 描述 | 1825| -- | -- | 1826| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1827 1828### OH_UdmfOptions_GetKey() 1829 1830``` 1831const char* OH_UdmfOptions_GetKey(OH_UdmfOptions* pThis) 1832``` 1833 1834**描述** 1835 1836从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据的唯一标识符信息。 1837 1838**起始版本：** 20 1839 1840 1841**参数：** 1842 1843| 参数项 | 描述 | 1844| -- | -- | 1845| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1846 1847**返回：** 1848 1849| 类型 | 说明 | 1850| -- | -- | 1851| const char* | 输入有效入参时返回符串指针，否则返回nullptr。 | 1852 1853### OH_UdmfOptions_SetKey() 1854 1855``` 1856int OH_UdmfOptions_SetKey(OH_UdmfOptions* pThis, const char* key) 1857``` 1858 1859**描述** 1860 1861设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据的唯一标识符内容参数。 1862 1863**起始版本：** 20 1864 1865 1866**参数：** 1867 1868| 参数项 | 描述 | 1869| -- | -- | 1870| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1871| const char* key | 数据的唯一标识符的新字符串值。 | 1872 1873**返回：** 1874 1875| 类型 | 说明 | 1876| -- | -- | 1877| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1878 1879### OH_UdmfOptions_GetIntention() 1880 1881``` 1882Udmf_Intention OH_UdmfOptions_GetIntention(OH_UdmfOptions* pThis) 1883``` 1884 1885**描述** 1886 1887从数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中获取数据通路信息。 1888 1889**起始版本：** 20 1890 1891 1892**参数：** 1893 1894| 参数项 | 描述 | 1895| -- | -- | 1896| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1897 1898**返回：** 1899 1900| 类型 | 说明 | 1901| -- | -- | 1902| [Udmf_Intention](#udmf_intention) | 返回[Udmf_Intention](capi-udmf-h.md#udmf_intention)的值。 | 1903 1904### OH_UdmfOptions_SetIntention() 1905 1906``` 1907int OH_UdmfOptions_SetIntention(OH_UdmfOptions* pThis, Udmf_Intention intention) 1908``` 1909 1910**描述** 1911 1912设置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例中的数据通路内容参数。 1913 1914**起始版本：** 20 1915 1916 1917**参数：** 1918 1919| 参数项 | 描述 | 1920| -- | -- | 1921| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1922| [Udmf_Intention](#udmf_intention) intention | 数据通路类型参数。 | 1923 1924**返回：** 1925 1926| 类型 | 说明 | 1927| -- | -- | 1928| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1929 1930### OH_UdmfOptions_Reset() 1931 1932``` 1933int OH_UdmfOptions_Reset(OH_UdmfOptions* pThis) 1934``` 1935 1936**描述** 1937 1938重置数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例为空。 1939 1940**起始版本：** 20 1941 1942 1943**参数：** 1944 1945| 参数项 | 描述 | 1946| -- | -- | 1947| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* pThis | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 1948 1949**返回：** 1950 1951| 类型 | 说明 | 1952| -- | -- | 1953| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。 | 1954 1955### OH_Udmf_GetUnifiedData() 1956 1957``` 1958int OH_Udmf_GetUnifiedData(const char* key, Udmf_Intention intention, OH_UdmfData* unifiedData) 1959``` 1960 1961**描述** 1962 1963从统一数据管理框架数据库中获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 1964 1965**起始版本：** 12 1966 1967 1968**参数：** 1969 1970| 参数项 | 描述 | 1971| -- | -- | 1972| const char* key | 表示数据库存储的唯一标识符。 | 1973| [Udmf_Intention](#udmf_intention) intention | 表示数据通路类型[Udmf_Intention](capi-udmf-h.md#udmf_intention)。 | 1974| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* unifiedData | 该参数是输出参数，获取到的统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)会写入该变量。 | 1975 1976**返回：** 1977 1978| 类型 | 说明 | 1979| -- | -- | 1980| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 1981 1982### OH_Udmf_GetUnifiedDataByOptions() 1983 1984``` 1985int OH_Udmf_GetUnifiedDataByOptions(OH_UdmfOptions* options, OH_UdmfData** dataArray, unsigned int* dataSize) 1986``` 1987 1988**描述** 1989 1990通过数据通路类型从统一数据管理框架数据库中获取统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 1991 1992**起始版本：** 20 1993 1994 1995**参数：** 1996 1997| 参数项 | 描述 | 1998| -- | -- | 1999| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* options | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 2000| [OH_UdmfData](capi-udmf-oh-udmfdata.md)** dataArray | 该参数是输出参数，表示统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)列表，<br>此指针需要使用[OH_Udmf_DestroyDataArray](capi-udmf-h.md#oh_udmf_destroydataarray)函数释放。 | 2001| unsigned int* dataSize | 该参数是输出参数，表示获取到的统一数据对象个数。 | 2002 2003**返回：** 2004 2005| 类型 | 说明 | 2006| -- | -- | 2007| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 2008 2009### OH_Udmf_SetUnifiedData() 2010 2011``` 2012int OH_Udmf_SetUnifiedData(Udmf_Intention intention, OH_UdmfData* unifiedData, char* key, unsigned int keyLen) 2013``` 2014 2015**描述** 2016 2017从统一数据管理框架数据库中写入统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 2018 2019**起始版本：** 12 2020 2021 2022**参数：** 2023 2024| 参数项 | 描述 | 2025| -- | -- | 2026| [Udmf_Intention](#udmf_intention) intention | 表示数据通路类型[Udmf_Intention](capi-udmf-h.md#udmf_intention)。 | 2027| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* unifiedData | 表示统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 | 2028| char* key | 表示成功将数据设置到数据库后对应数据的唯一标识符。 | 2029| unsigned int keyLen | 表示唯一标识符参数的空间大小，内存大小不小于512字节。 | 2030 2031**返回：** 2032 2033| 类型 | 说明 | 2034| -- | -- | 2035| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 2036 2037### OH_Udmf_SetUnifiedDataByOptions() 2038 2039``` 2040int OH_Udmf_SetUnifiedDataByOptions(OH_UdmfOptions* options, OH_UdmfData *unifiedData, char *key, unsigned int keyLen) 2041``` 2042 2043**描述** 2044 2045从统一数据管理框架数据库中写入统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 2046 2047**起始版本：** 20 2048 2049 2050**参数：** 2051 2052| 参数项 | 描述 | 2053| -- | -- | 2054| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* options | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 2055| [OH_UdmfData](capi-udmf-oh-udmfdata.md) *unifiedData | 指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 2056| char *key | 成功将数据设置到数据库后对应数据的唯一标识符，内存大小不小于[UDMF_KEY_BUFFER_LEN](#udmf_key_buffer_len)。 | 2057| unsigned int keyLen | 唯一标识符参数的空间大小。 | 2058 2059**返回：** 2060 2061| 类型 | 说明 | 2062| -- | -- | 2063| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 2064 2065### OH_Udmf_UpdateUnifiedData() 2066 2067``` 2068int OH_Udmf_UpdateUnifiedData(OH_UdmfOptions* options, OH_UdmfData* unifiedData) 2069``` 2070 2071**描述** 2072 2073对统一数据管理框架数据库中的统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据进行数据更改。 2074 2075**起始版本：** 20 2076 2077 2078**参数：** 2079 2080| 参数项 | 描述 | 2081| -- | -- | 2082| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* options | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 2083| [OH_UdmfData](capi-udmf-oh-udmfdata.md)* unifiedData | 指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)实例的指针。 | 2084 2085**返回：** 2086 2087| 类型 | 说明 | 2088| -- | -- | 2089| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 2090 2091### OH_Udmf_DeleteUnifiedData() 2092 2093``` 2094int OH_Udmf_DeleteUnifiedData(OH_UdmfOptions* options, OH_UdmfData** dataArray, unsigned int* dataSize) 2095``` 2096 2097**描述** 2098 2099删除统一数据管理框架数据库中的统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)数据。 2100 2101**起始版本：** 20 2102 2103 2104**参数：** 2105 2106| 参数项 | 描述 | 2107| -- | -- | 2108| [OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)* options | 指向数据操作选项[OH_UdmfOptions](capi-udmf-oh-udmfoptions.md)实例的指针。 | 2109| [OH_UdmfData](capi-udmf-oh-udmfdata.md)** dataArray | 该参数是输出参数，统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)列表，<br>此指针需要使用[OH_Udmf_DestroyDataArray](capi-udmf-h.md#oh_udmf_destroydataarray)函数释放。 | 2110| unsigned int* dataSize | 该参数是输出参数，表示获取到的统一数据对象个数。 | 2111 2112**返回：** 2113 2114| 类型 | 说明 | 2115| -- | -- | 2116| int | 返回执行的错误码。请参阅错误码定义[Udmf_ErrCode](capi-udmf-err-code-h.md#udmf_errcode)。<br>若返回UDMF_E_OK，表示执行成功。<br>若返回UDMF_E_INVALID_PARAM，表示传入了无效参数。<br>若返回UDMF_ERR，表示内部数据错误。 | 2117 2118### OH_Udmf_DestroyDataArray() 2119 2120``` 2121void OH_Udmf_DestroyDataArray(OH_UdmfData** dataArray, unsigned int dataSize) 2122``` 2123 2124**描述** 2125 2126销毁数据数组内存。 2127 2128**起始版本：** 20 2129 2130 2131**参数：** 2132 2133| 参数项 | 描述 | 2134| -- | -- | 2135| [OH_UdmfData](capi-udmf-oh-udmfdata.md)** dataArray | 指向统一数据对象[OH_UdmfData](capi-udmf-oh-udmfdata.md)的指针列表。 | 2136| unsigned int dataSize | 列表中的数据大小。 | 2137 2138**参考：** 2139 2140OH_UdmfData 2141 2142### OH_UdmfProgressInfo_GetProgress() 2143 2144``` 2145int OH_UdmfProgressInfo_GetProgress(OH_Udmf_ProgressInfo* progressInfo) 2146``` 2147 2148**描述** 2149 2150从进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)中获取进度百分比数据。 2151 2152**起始版本：** 15 2153 2154 2155**参数：** 2156 2157| 参数项 | 描述 | 2158| -- | -- | 2159| [OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)* progressInfo | 表示进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)。 | 2160 2161**返回：** 2162 2163| 类型 | 说明 | 2164| -- | -- | 2165| int | 返回进度百分比数据。 | 2166 2167### OH_UdmfProgressInfo_GetStatus() 2168 2169``` 2170int OH_UdmfProgressInfo_GetStatus(OH_Udmf_ProgressInfo* progressInfo) 2171``` 2172 2173**描述** 2174 2175从进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)中获取状态信息。 2176 2177**起始版本：** 15 2178 2179 2180**参数：** 2181 2182| 参数项 | 描述 | 2183| -- | -- | 2184| [OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)* progressInfo | 表示进度信息[OH_Udmf_ProgressInfo](capi-udmf-oh-udmf-progressinfo.md)。 | 2185 2186**返回：** 2187 2188| 类型 | 说明 | 2189| -- | -- | 2190| int | 返回状态信息。 | 2191 2192### OH_UdmfGetDataParams_Create() 2193 2194``` 2195OH_UdmfGetDataParams* OH_UdmfGetDataParams_Create() 2196``` 2197 2198**描述** 2199 2200创建异步获取UDMF数据的请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)指针及实例对象。<br>当不再需要使用指针时，请使用[OH_UdmfGetDataParams_Destroy](capi-udmf-h.md#oh_udmfgetdataparams_destroy)销毁实例对象，否则会导致内存泄漏。 2201 2202**起始版本：** 15 2203 2204**返回：** 2205 2206| 类型 | 说明 | 2207| -- | -- | 2208| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* | 执行成功则返回一个指向属性[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例对象的指针，否则返回nullptr。 | 2209 2210### OH_UdmfGetDataParams_Destroy() 2211 2212``` 2213void OH_UdmfGetDataParams_Destroy(OH_UdmfGetDataParams* pThis) 2214``` 2215 2216**描述** 2217 2218销毁异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)指针指向的实例对象。 2219 2220**起始版本：** 15 2221 2222 2223**参数：** 2224 2225| 参数项 | 描述 | 2226| -- | -- | 2227| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* pThis | 表示指向异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 2228 2229### OH_UdmfGetDataParams_SetDestUri() 2230 2231``` 2232void OH_UdmfGetDataParams_SetDestUri(OH_UdmfGetDataParams* params, const char* destUri) 2233``` 2234 2235**描述** 2236 2237设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的目标路径。<br>若设置了目标路径，会将文件类型的数据进行拷贝到指定路径。回调中获取到的文件类型数据会被替换为目标路径的URI。<br>若不设置目标路径，则不会执行拷贝文件操作。回调中获取到的文件类型数据为源端路径URI。<br>若应用涉及复杂文件处理策略，或需要将文件拷贝在多个路径下时，建议不设置此参数，由应用自行完成文件拷贝相关处理。 2238 2239**起始版本：** 15 2240 2241 2242**参数：** 2243 2244| 参数项 | 描述 | 2245| -- | -- | 2246| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* params | 表示指向异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 2247| const char* destUri | 表示目标路径地址。 | 2248 2249### OH_UdmfGetDataParams_SetFileConflictOptions() 2250 2251``` 2252void OH_UdmfGetDataParams_SetFileConflictOptions(OH_UdmfGetDataParams* params, const Udmf_FileConflictOptions options) 2253``` 2254 2255**描述** 2256 2257设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的文件冲突选项。 2258 2259**起始版本：** 15 2260 2261 2262**参数：** 2263 2264| 参数项 | 描述 | 2265| -- | -- | 2266| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* params | 表示指向异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 2267| const [Udmf_FileConflictOptions](#udmf_fileconflictoptions) options | 表示文件拷贝冲突时的选项。 | 2268 2269### OH_UdmfGetDataParams_SetProgressIndicator() 2270 2271``` 2272void OH_UdmfGetDataParams_SetProgressIndicator(OH_UdmfGetDataParams* params, const Udmf_ProgressIndicator progressIndicator) 2273``` 2274 2275**描述** 2276 2277设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的进度条指示选项。 2278 2279**起始版本：** 15 2280 2281 2282**参数：** 2283 2284| 参数项 | 描述 | 2285| -- | -- | 2286| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* params | 表示指向异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 2287| const [Udmf_ProgressIndicator](#udmf_progressindicator) progressIndicator | 表示是否使用默认进度条选项。 | 2288 2289### OH_UdmfGetDataParams_SetDataProgressListener() 2290 2291``` 2292void OH_UdmfGetDataParams_SetDataProgressListener(OH_UdmfGetDataParams* params, const OH_Udmf_DataProgressListener dataProgressListener) 2293``` 2294 2295**描述** 2296 2297设置异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)中的监听回调函数。 2298 2299**起始版本：** 15 2300 2301 2302**参数：** 2303 2304| 参数项 | 描述 | 2305| -- | -- | 2306| [OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)* params | 表示指向异步请求参数[OH_UdmfGetDataParams](capi-udmf-oh-udmfgetdataparams.md)实例的指针。 | 2307| const [OH_Udmf_DataProgressListener](#oh_udmf_dataprogresslistener) dataProgressListener | 用户自定义的监听回调函数，可用于获取进度信息和数据。 |