文档管理中心

uds.h

本文导读
展开章节

概述

PhonePC/2in1TabletTV

提供标准化数据结构相关接口函数、结构体定义。当参数类型为char*时,字符串必须以空字符('\0')结尾。

引用文件: <database/udmf/uds.h>

库: libudmf.so

系统能力: SystemCapability.DistributedDataManager.UDMF.Core

起始版本: 12

相关模块: UDMF

汇总

PhonePC/2in1TabletTV

结构体

PhonePC/2in1TabletTV
展开
名称 typedef关键字 描述
OH_UdsPlainText OH_UdsPlainText 描述纯文本类型数据的统一数据结构。
OH_UdsHyperlink OH_UdsHyperlink 描述超链接类型的统一数据结构。
OH_UdsHtml OH_UdsHtml 描述超文本标记语言类型的统一数据结构。
OH_UdsAppItem OH_UdsAppItem 描述桌面图标类型的统一数据结构。
OH_UdsFileUri OH_UdsFileUri 描述文件Uri类型的统一数据结构。
OH_UdsPixelMap OH_UdsPixelMap 描述像素图片类型的统一数据结构。
OH_UdsArrayBuffer OH_UdsArrayBuffer 描述ArrayBuffer类型的统一数据结构。
OH_UdsContentForm OH_UdsContentForm 描述内容卡片类型的统一数据结构。
OH_UdsDetails OH_UdsDetails 描述字典类型的统一数据结构。

枚举

PhonePC/2in1TabletTV
展开
名称 typedef关键字 描述
Udmf_AuthPermission Udmf_AuthPermission

拖拽场景下的URI授权策略。

说明:此授权策略仅在拖拽场景下生效,其他场景不生效。

函数

PhonePC/2in1TabletTV
展开
名称 描述
OH_UdsPlainText* OH_UdsPlainText_Create() 创建纯文本类型OH_UdsPlainText指针及实例对象。当不再需要使用指针时,请使用OH_UdsPlainText_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsPlainText_Destroy(OH_UdsPlainText* pThis) 销毁纯文本类型数据OH_UdsPlainText指针指向的实例对象。
const char* OH_UdsPlainText_GetType(OH_UdsPlainText* pThis) 从纯文本类型OH_UdsPlainText中获取类型ID。
const char* OH_UdsPlainText_GetContent(OH_UdsPlainText* pThis) 从纯文本类型OH_UdsPlainText中获取纯文本内容信息。
const char* OH_UdsPlainText_GetAbstract(OH_UdsPlainText* pThis) 从纯文本类型OH_UdsPlainText中获取纯文本摘要信息。
int OH_UdsPlainText_SetContent(OH_UdsPlainText* pThis, const char* content) 设置纯文本类型OH_UdsPlainText中的纯文本内容参数。
int OH_UdsPlainText_SetAbstract(OH_UdsPlainText* pThis, const char* abstract) 设置纯文本类型OH_UdsPlainText中的纯文本摘要参数。
OH_UdsHyperlink* OH_UdsHyperlink_Create() 创建超链接类型OH_UdsHyperlink指针及实例对象。当不再需要使用指针时,请使用OH_UdsHyperlink_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsHyperlink_Destroy(OH_UdsHyperlink* pThis) 销毁超链接类型OH_UdsHyperlink指针指向的实例对象。
const char* OH_UdsHyperlink_GetType(OH_UdsHyperlink* pThis) 从超链接类型OH_UdsHyperlink中获取类型ID。
const char* OH_UdsHyperlink_GetUrl(OH_UdsHyperlink* pThis) 从超链接类型OH_UdsHyperlink中获取URL参数。
const char* OH_UdsHyperlink_GetDescription(OH_UdsHyperlink* pThis) 从超链接类型OH_UdsHyperlink中获取描述参数。
int OH_UdsHyperlink_SetUrl(OH_UdsHyperlink* pThis, const char* url) 设置超链接类型OH_UdsHyperlink实例中URL参数。
int OH_UdsHyperlink_SetDescription(OH_UdsHyperlink* pThis, const char* description) 设置超链接类型OH_UdsHyperlink实例中描述参数。
OH_UdsHtml* OH_UdsHtml_Create() 创建超文本标记语言类型OH_UdsHtml指针及实例对象。当不再需要使用指针时,请使用OH_UdsHtml_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsHtml_Destroy(OH_UdsHtml* pThis) 销毁超文本标记语言类型OH_UdsHtml指针指向的实例对象。
const char* OH_UdsHtml_GetType(OH_UdsHtml* pThis) 获取超文本标记语言类型OH_UdsHtml对象中类型ID。
const char* OH_UdsHtml_GetContent(OH_UdsHtml* pThis) 获取超文本标记语言类型OH_UdsHtml对象中HTML格式内容参数。
const char* OH_UdsHtml_GetPlainContent(OH_UdsHtml* pThis) 获取超文本标记语言类型OH_UdsHtml对象中的纯文本内容参数。
int OH_UdsHtml_SetContent(OH_UdsHtml* pThis, const char* content) 设置超文本标记语言类型OH_UdsHtml中的HTML格式内容参数。
int OH_UdsHtml_SetPlainContent(OH_UdsHtml* pThis, const char* plainContent) 设置超文本标记语言类型OH_UdsHtml中的纯文本内容参数。
OH_UdsAppItem* OH_UdsAppItem_Create() 创建桌面图标类型OH_UdsAppItem指针及实例对象。当不再需要使用指针时,请使用OH_UdsAppItem_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsAppItem_Destroy(OH_UdsAppItem* pThis) 销毁桌面图标类型OH_UdsAppItem指针指向的实例对象。
const char* OH_UdsAppItem_GetType(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例获取类型ID。
const char* OH_UdsAppItem_GetId(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取应用ID。
const char* OH_UdsAppItem_GetName(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取应用名称。
const char* OH_UdsAppItem_GetIconId(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取图片ID。
const char* OH_UdsAppItem_GetLabelId(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取标签ID。
const char* OH_UdsAppItem_GetBundleName(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取bundle名称。
const char* OH_UdsAppItem_GetAbilityName(OH_UdsAppItem* pThis) 从桌面图标类型OH_UdsAppItem实例中获取ability名称。
int OH_UdsAppItem_SetId(OH_UdsAppItem* pThis, const char* appId) 设置桌面图标类型OH_UdsAppItem对象的应用ID。
int OH_UdsAppItem_SetName(OH_UdsAppItem* pThis, const char* appName) 设置桌面图标类型OH_UdsAppItem对象的应用名称。
int OH_UdsAppItem_SetIconId(OH_UdsAppItem* pThis, const char* appIconId) 设置桌面图标类型OH_UdsAppItem对象的图片ID。
int OH_UdsAppItem_SetLabelId(OH_UdsAppItem* pThis, const char* appLabelId) 设置桌面图标类型OH_UdsAppItem对象的标签ID。
int OH_UdsAppItem_SetBundleName(OH_UdsAppItem* pThis, const char* bundleName) 设置桌面图标类型OH_UdsAppItem对象的bundle名称。
int OH_UdsAppItem_SetAbilityName(OH_UdsAppItem* pThis, const char* abilityName) 设置桌面图标类型OH_UdsAppItem对象的ability名称。
OH_UdsFileUri* OH_UdsFileUri_Create() 创建文件Uri类型OH_UdsFileUri的实例对象以及指向它的指针。当不再需要使用指针时,请使用OH_UdsFileUri_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsFileUri_Destroy(OH_UdsFileUri* pThis) 销毁文件Uri类型OH_UdsFileUri的实例对象。
const char* OH_UdsFileUri_GetType(OH_UdsFileUri* pThis) 从文件Uri类型OH_UdsFileUri实例中获取类型ID。
const char* OH_UdsFileUri_GetFileUri(OH_UdsFileUri* pThis) 从文件Uri类型OH_UdsFileUri实例中获取文件Uri。
const char* OH_UdsFileUri_GetFileType(OH_UdsFileUri* pThis) 从文件Uri类型OH_UdsFileUri实例中获取文件类型。
int OH_UdsFileUri_SetFileUri(OH_UdsFileUri* pThis, const char* fileUri) 设置文件Uri类型OH_UdsFileUri对象的Uri信息。
int OH_UdsFileUri_SetFileType(OH_UdsFileUri* pThis, const char* fileType) 设置文件Uri类型OH_UdsFileUri对象的文件类型。
OH_UdsPixelMap* OH_UdsPixelMap_Create() 创建像素图片类型OH_UdsPixelMap的实例对象以及指向它的指针。当不再需要使用指针时,请使用OH_UdsPixelMap_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsPixelMap_Destroy(OH_UdsPixelMap* pThis) 销毁像素图片类型OH_UdsPixelMap的实例对象。
const char* OH_UdsPixelMap_GetType(OH_UdsPixelMap* pThis) 从像素图片类型OH_UdsPixelMap实例中获取类型ID。
void OH_UdsPixelMap_GetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative) 从像素图片类型OH_UdsPixelMap实例中获取像素图片OH_PixelmapNative实例的指针。
int OH_UdsPixelMap_SetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative) 设置像素图片类型OH_UdsPixelMap对象的像素图片内容。
OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create() 创建ArrayBuffer类型OH_UdsArrayBuffer的实例对象以及指向它的指针。当不再需要使用指针时,请使用OH_UdsArrayBuffer_Destroy销毁实例对象,否则会导致内存泄漏。
int OH_UdsArrayBuffer_Destroy(OH_UdsArrayBuffer* buffer) 销毁ArrayBuffer类型OH_UdsArrayBuffer的实例对象。
int OH_UdsArrayBuffer_SetData(OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len) 设置ArrayBuffer类型OH_UdsArrayBuffer对象的数据内容。
int OH_UdsArrayBuffer_GetData(OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len) 从ArrayBuffer类型OH_UdsArrayBuffer实例中获取用户自定义的ArrayBuffer数据内容。
OH_UdsContentForm* OH_UdsContentForm_Create() 创建内容卡片类型OH_UdsContentForm指针及实例对象。当不再需要使用指针时,请使用OH_UdsContentForm_Destroy销毁实例对象,否则会导致内存泄漏。
void OH_UdsContentForm_Destroy(OH_UdsContentForm* pThis) 销毁内容卡片类型数据OH_UdsContentForm指针指向的实例对象。
const char* OH_UdsContentForm_GetType(OH_UdsContentForm* pThis) 从内容卡片类型OH_UdsContentForm中获取类型ID。
int OH_UdsContentForm_GetThumbData(OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len) 从内容卡片类型OH_UdsContentForm中获取图片数据。
const char* OH_UdsContentForm_GetDescription(OH_UdsContentForm* pThis) 从内容卡片类型OH_UdsContentForm中获取描述信息。
const char* OH_UdsContentForm_GetTitle(OH_UdsContentForm* pThis) 从内容卡片类型OH_UdsContentForm中获取标题信息。
int OH_UdsContentForm_GetAppIcon(OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len) 从内容卡片类型OH_UdsContentForm中获取应用图标数据。
const char* OH_UdsContentForm_GetAppName(OH_UdsContentForm* pThis) 从内容卡片类型OH_UdsContentForm中获取应用名称信息。
const char* OH_UdsContentForm_GetLinkUri(OH_UdsContentForm* pThis) 从内容卡片类型OH_UdsContentForm中获取超链接信息。
int OH_UdsContentForm_SetThumbData(OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len) 设置内容卡片类型OH_UdsContentForm中的图片数据。
int OH_UdsContentForm_SetDescription(OH_UdsContentForm* pThis, const char* description) 设置内容卡片类型OH_UdsContentForm中的描述信息。
int OH_UdsContentForm_SetTitle(OH_UdsContentForm* pThis, const char* title) 设置内容卡片类型OH_UdsContentForm中的标题信息。
int OH_UdsContentForm_SetAppIcon(OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len) 设置内容卡片类型OH_UdsContentForm中的应用图标数据。
int OH_UdsContentForm_SetAppName(OH_UdsContentForm* pThis, const char* appName) 设置内容卡片类型OH_UdsContentForm中的应用名称数据。
int OH_UdsContentForm_SetLinkUri(OH_UdsContentForm* pThis, const char* linkUri) 设置内容卡片类型OH_UdsContentForm中的超链接数据。
int OH_UdsPlainText_GetDetails(OH_UdsPlainText* pThis, OH_UdsDetails* details) 从纯文本类型OH_UdsPlainText中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsPlainText_SetDetails(OH_UdsPlainText* pThis, const OH_UdsDetails* details) 设置纯文本类型OH_UdsPlainText中的字典类型OH_UdsDetails参数。
int OH_UdsHyperlink_GetDetails(OH_UdsHyperlink* pThis, OH_UdsDetails* details) 从超链接类型OH_UdsHyperlink中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsHyperlink_SetDetails(OH_UdsHyperlink* pThis, const OH_UdsDetails* details) 设置超链接类型OH_UdsHyperlink实例中的字典类型OH_UdsDetails参数。
int OH_UdsHtml_GetDetails(OH_UdsHtml* pThis, OH_UdsDetails* details) 从超文本标记语言类型OH_UdsHtml对象中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsHtml_SetDetails(OH_UdsHtml* pThis, const OH_UdsDetails* details) 设置超文本标记语言类型OH_UdsHtml中的字典类型OH_UdsDetails参数。
int OH_UdsAppItem_GetDetails(OH_UdsAppItem* pThis, OH_UdsDetails* details) 从桌面图标类型OH_UdsAppItem实例中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsAppItem_SetDetails(OH_UdsAppItem* pThis, const OH_UdsDetails* details) 设置桌面图标类型OH_UdsAppItem对象的字典类型OH_UdsDetails参数。
int OH_UdsFileUri_GetDetails(OH_UdsFileUri* pThis, OH_UdsDetails* details) 从文件Uri类型OH_UdsFileUri实例中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsFileUri_SetDetails(OH_UdsFileUri* pThis, const OH_UdsDetails* details) 设置文件Uri类型OH_UdsFileUri对象的字典类型OH_UdsDetails参数。
int OH_UdsPixelMap_GetDetails(OH_UdsPixelMap* pThis, OH_UdsDetails* details) 从像素图片类型OH_UdsPixelMap实例中获取字典类型OH_UdsDetails实例的指针。
int OH_UdsPixelMap_SetDetails(OH_UdsPixelMap* pThis, const OH_UdsDetails* details) 设置像素图片类型OH_UdsPixelMap对象的字典类型OH_UdsDetails参数。
OH_UdsDetails* OH_UdsDetails_Create()

创建字典类型OH_UdsDetails指针及实例对象。

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

void OH_UdsDetails_Destroy(OH_UdsDetails* pThis) 销毁字典类型OH_UdsDetails指针指向的实例对象。
bool OH_UdsDetails_HasKey(const OH_UdsDetails* pThis, const char* key) 检查字典类型OH_UdsDetails中是否存在指定键。
int OH_UdsDetails_Remove(OH_UdsDetails* pThis, const char* key) 删除字典类型OH_UdsDetails中指定键值对。
int OH_UdsDetails_Clear(OH_UdsDetails* pThis) 清除字典类型OH_UdsDetails中所有数据。
int OH_UdsDetails_SetValue(OH_UdsDetails* pThis, const char* key, const char* value) 向字典类型OH_UdsDetails中添加键值对数据。
const char* OH_UdsDetails_GetValue(const OH_UdsDetails* pThis, const char* key) 获取字典类型OH_UdsDetails中指定的键对应的值。
char** OH_UdsDetails_GetAllKeys(OH_UdsDetails* pThis, unsigned int* count) 获取字典类型OH_UdsDetails中所有键的结果集。
int OH_UdsHtml_SetAuthPolicy(OH_UdsHtml* pThis, uint32_t authPolicy)

OH_UdsHtml设置授权策略。

说明:此授权策略仅在拖拽场景下生效,其他场景不生效。

int OH_UdsFileUri_SetAuthPolicy(OH_UdsFileUri* pThis, uint32_t authPolicy)

OH_UdsFileUri设置授权策略。

说明:此授权策略仅在拖拽场景下生效,其他场景不生效。

枚举类型说明

PhonePC/2in1TabletTV

Udmf_AuthPermissionBeta

PhonePC/2in1TabletTV
enum Udmf_AuthPermission

描述

拖拽场景下的URI授权策略。

说明

此授权策略仅在拖拽场景下生效,其他场景不生效。

支持不授权、读、写、持久化四种权限策略,可组合使用,仅以下组合生效:

  • 仅使用NONE:不做任何文件授权。

  • 仅使用READ:仅做单次只读授权。

  • 仅使用WRITE:做单次读、写授权(写授权包含读授权)。

  • READ+WRITE:做单次读、写授权,与仅写授权等同。

  • READ+PERSIST:做持久化读授权。

  • WRITE+PERSIST:做持久化读写授权。

  • READ+WRITE+PERSIST:做持久化读写授权。

拖拽授权策略应用规则(按优先级从高到低):

  • 单个数据级别:FileUri、HTML两个UDS支持配置授权策略参数,仅对单个record单次生效,优先级最高。

  • OH_UdmfData级别:OH_UdmfProperty中提供的授权参数对单次拖拽有效。若某个数据中配置了授权策略,则优先按照该数据的配置进行,优先级次之。

  • 默认级别:若单个数据和OH_UdmfProperty均未配置授权策略,则按照拖拽默认逻辑进行代理授权。默认逻辑如下:

  • FileUri类型数据:拖拽场景下默认授权为READ+WRITE+PERSIST(读+写+持久化授权)。

  • HTML类型数据,仅针对HTML文本中img标签下的uri做读授权。

起始版本: 26.0.0

展开
枚举项 描述
UDMF_PERM_NONE = 0 表示未授予任何权限。
UDMF_PERM_READ = 1u << 0 表示读取或查看数据的权限。
UDMF_PERM_WRITE = 1u << 1 表示修改数据的权限(包含READ)。
UDMF_PERM_PERSIST = 1u << 2 表示持久化文件的权限。

函数说明

PhonePC/2in1TabletTV

OH_UdsPlainText_Create()

PhonePC/2in1TabletTV
OH_UdsPlainText* OH_UdsPlainText_Create()

描述

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

起始版本: 12

返回:

展开
类型 说明
OH_UdsPlainText* 执行成功则返回一个指向纯文本类型OH_UdsPlainText实例对象的指针,否则返回nullptr。

OH_UdsPlainText_Destroy()

PhonePC/2in1TabletTV
void OH_UdsPlainText_Destroy(OH_UdsPlainText* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向OH_UdsPlainText实例的指针。

OH_UdsPlainText_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsPlainText_GetType(OH_UdsPlainText* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsPlainText_GetContent()

PhonePC/2in1TabletTV
const char* OH_UdsPlainText_GetContent(OH_UdsPlainText* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回纯文本内容信息的字符串指针,否则返回nullptr。

OH_UdsPlainText_GetAbstract()

PhonePC/2in1TabletTV
const char* OH_UdsPlainText_GetAbstract(OH_UdsPlainText* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回纯文本摘要信息的字符串指针,否则返回nullptr。

OH_UdsPlainText_SetContent()

PhonePC/2in1TabletTV
int OH_UdsPlainText_SetContent(OH_UdsPlainText* pThis, const char* content)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。
const char* content 表示纯文本内容参数。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPlainText_SetAbstract()

PhonePC/2in1TabletTV
int OH_UdsPlainText_SetAbstract(OH_UdsPlainText* pThis, const char* abstract)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。
const char* abstract 表示纯文本摘要参数。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

PhonePC/2in1TabletTV
OH_UdsHyperlink* OH_UdsHyperlink_Create()

描述

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

起始版本: 12

返回:

展开
类型 说明
OH_UdsHyperlink* 执行成功则返回一个指向超链接类型OH_UdsHyperlink实例对象的指针,否则返回nullptr。
PhonePC/2in1TabletTV
void OH_UdsHyperlink_Destroy(OH_UdsHyperlink* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。
PhonePC/2in1TabletTV
const char* OH_UdsHyperlink_GetType(OH_UdsHyperlink* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。
PhonePC/2in1TabletTV
const char* OH_UdsHyperlink_GetUrl(OH_UdsHyperlink* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回URL参数的字符串指针,否则返回nullptr。
PhonePC/2in1TabletTV
const char* OH_UdsHyperlink_GetDescription(OH_UdsHyperlink* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回描述参数的字符串指针,否则返回nullptr。
PhonePC/2in1TabletTV
int OH_UdsHyperlink_SetUrl(OH_UdsHyperlink* pThis, const char* url)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。
const char* url 表示URL参数。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

PhonePC/2in1TabletTV
int OH_UdsHyperlink_SetDescription(OH_UdsHyperlink* pThis, const char* description)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。
const char* description 表示描述信息。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsHtml_Create()

PhonePC/2in1TabletTV
OH_UdsHtml* OH_UdsHtml_Create()

描述

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

起始版本: 12

返回:

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

OH_UdsHtml_Destroy()

PhonePC/2in1TabletTV
void OH_UdsHtml_Destroy(OH_UdsHtml* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。

OH_UdsHtml_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsHtml_GetType(OH_UdsHtml* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsHtml_GetContent()

PhonePC/2in1TabletTV
const char* OH_UdsHtml_GetContent(OH_UdsHtml* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回HTML格式内容的字符串指针,否则返回nullptr。

OH_UdsHtml_GetPlainContent()

PhonePC/2in1TabletTV
const char* OH_UdsHtml_GetPlainContent(OH_UdsHtml* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回纯文本内容的字符串指针,否则返回nullptr。

OH_UdsHtml_SetContent()

PhonePC/2in1TabletTV
int OH_UdsHtml_SetContent(OH_UdsHtml* pThis, const char* content)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。
const char* content 表示HTML格式内容参数。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsHtml_SetPlainContent()

PhonePC/2in1TabletTV
int OH_UdsHtml_SetPlainContent(OH_UdsHtml* pThis, const char* plainContent)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。
const char* plainContent 表示纯文本内容参数。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_Create()

PhonePC/2in1TabletTV
OH_UdsAppItem* OH_UdsAppItem_Create()

描述

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

起始版本: 12

返回:

展开
类型 说明
OH_UdsAppItem* 执行成功则返回一个指向桌面图标类型OH_UdsAppItem实例对象的指针,否则返回nullptr。

OH_UdsAppItem_Destroy()

PhonePC/2in1TabletTV
void OH_UdsAppItem_Destroy(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

OH_UdsAppItem_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetType(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetId()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetId(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回应用ID的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetName()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetName(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回应用名称的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetIconId()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetIconId(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回图片ID的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetLabelId()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetLabelId(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回标签ID的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetBundleName()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetBundleName(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回bundle名称的字符串指针,否则返回nullptr。

OH_UdsAppItem_GetAbilityName()

PhonePC/2in1TabletTV
const char* OH_UdsAppItem_GetAbilityName(OH_UdsAppItem* pThis)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回ability名称的字符串指针,否则返回nullptr。

OH_UdsAppItem_SetId()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetId(OH_UdsAppItem* pThis, const char* appId)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* appId 表示应用ID。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetName()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetName(OH_UdsAppItem* pThis, const char* appName)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* appName 表示应用名称。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetIconId()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetIconId(OH_UdsAppItem* pThis, const char* appIconId)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* appIconId 表示图片ID。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetLabelId()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetLabelId(OH_UdsAppItem* pThis, const char* appLabelId)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* appLabelId 表示标签ID。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetBundleName()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetBundleName(OH_UdsAppItem* pThis, const char* bundleName)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* bundleName 表示bundle名称。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetAbilityName()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetAbilityName(OH_UdsAppItem* pThis, const char* abilityName)

描述

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

起始版本: 12

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const char* abilityName 表示ability名称。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsFileUri_Create()

PhonePC/2in1TabletTV
OH_UdsFileUri* OH_UdsFileUri_Create()

描述

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

起始版本: 13

返回:

展开
类型 说明
OH_UdsFileUri* 执行成功则返回一个指向文件Uri类型OH_UdsFileUri实例对象的指针,否则返回nullptr。

OH_UdsFileUri_Destroy()

PhonePC/2in1TabletTV
void OH_UdsFileUri_Destroy(OH_UdsFileUri* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。

OH_UdsFileUri_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsFileUri_GetType(OH_UdsFileUri* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsFileUri_GetFileUri()

PhonePC/2in1TabletTV
const char* OH_UdsFileUri_GetFileUri(OH_UdsFileUri* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回文件Uri的字符串指针,否则返回nullptr。

OH_UdsFileUri_GetFileType()

PhonePC/2in1TabletTV
const char* OH_UdsFileUri_GetFileType(OH_UdsFileUri* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回文件类型的字符串指针,否则返回nullptr。

OH_UdsFileUri_SetFileUri()

PhonePC/2in1TabletTV
int OH_UdsFileUri_SetFileUri(OH_UdsFileUri* pThis, const char* fileUri)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。
const char* fileUri 表示文件Uri。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsFileUri_SetFileType()

PhonePC/2in1TabletTV
int OH_UdsFileUri_SetFileType(OH_UdsFileUri* pThis, const char* fileType)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。
const char* fileType 表示文件类型。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPixelMap_Create()

PhonePC/2in1TabletTV
OH_UdsPixelMap* OH_UdsPixelMap_Create()

描述

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

起始版本: 13

返回:

展开
类型 说明
OH_UdsPixelMap* 执行成功则返回一个指向像素图片类型OH_UdsPixelMap实例对象的指针,否则返回nullptr。

OH_UdsPixelMap_Destroy()

PhonePC/2in1TabletTV
void OH_UdsPixelMap_Destroy(OH_UdsPixelMap* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。

OH_UdsPixelMap_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsPixelMap_GetType(OH_UdsPixelMap* pThis)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsPixelMap_GetPixelMap()

PhonePC/2in1TabletTV
void OH_UdsPixelMap_GetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。
OH_PixelmapNative* pixelmapNative 该参数是输出参数,表示指向像素图片OH_PixelmapNative实例的指针。

OH_UdsPixelMap_SetPixelMap()

PhonePC/2in1TabletTV
int OH_UdsPixelMap_SetPixelMap(OH_UdsPixelMap* pThis, OH_PixelmapNative* pixelmapNative)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。
OH_PixelmapNative* pixelmapNative 表示指向像素图片OH_PixelmapNative实例的指针。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsArrayBuffer_Create()

PhonePC/2in1TabletTV
OH_UdsArrayBuffer* OH_UdsArrayBuffer_Create()

描述

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

起始版本: 13

返回:

展开
类型 说明
OH_UdsArrayBuffer* 执行成功则返回一个指向ArrayBuffer类型OH_UdsArrayBuffer实例对象的指针,否则返回nullptr。

OH_UdsArrayBuffer_Destroy()

PhonePC/2in1TabletTV
int OH_UdsArrayBuffer_Destroy(OH_UdsArrayBuffer* buffer)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsArrayBuffer* buffer 表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsArrayBuffer_SetData()

PhonePC/2in1TabletTV
int OH_UdsArrayBuffer_SetData(OH_UdsArrayBuffer* buffer, unsigned char* data, unsigned int len)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsArrayBuffer* buffer 表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。
unsigned char* data 表示用户自定义的ArrayBuffer数据。
unsigned int len 表示用户自定义的ArrayBuffer数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsArrayBuffer_GetData()

PhonePC/2in1TabletTV
int OH_UdsArrayBuffer_GetData(OH_UdsArrayBuffer* buffer, unsigned char** data, unsigned int* len)

描述

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

起始版本: 13

参数:

展开
参数项 描述
OH_UdsArrayBuffer* buffer 表示指向ArrayBuffer类型OH_UdsArrayBuffer实例的指针。
unsigned char** data 该参数是输出参数,表示用户自定义的ArrayBuffer数据。
unsigned int* len 该参数是输出参数,表示用户自定义的ArrayBuffer数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_Create()

PhonePC/2in1TabletTV
OH_UdsContentForm* OH_UdsContentForm_Create()

描述

创建内容卡片类型OH_UdsContentForm指针及实例对象。当不再需要使用指针时,请使用OH_UdsContentForm_Destroy销毁实例对象,否则会导致内存泄漏。

起始版本: 14

返回:

展开
类型 说明
OH_UdsContentForm* 执行成功则返回一个指向内容卡片类型OH_UdsContentForm实例对象的指针,否则返回nullptr。

OH_UdsContentForm_Destroy()

PhonePC/2in1TabletTV
void OH_UdsContentForm_Destroy(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

OH_UdsContentForm_GetType()

PhonePC/2in1TabletTV
const char* OH_UdsContentForm_GetType(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回类型ID的字符串指针,否则返回nullptr。

OH_UdsContentForm_GetThumbData()

PhonePC/2in1TabletTV
int OH_UdsContentForm_GetThumbData(OH_UdsContentForm* pThis, unsigned char** thumbData, unsigned int* len)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
unsigned char** thumbData 该参数是输出参数,表示内容卡片中的图片二进制数据。
unsigned int* len 该参数是输出参数,表示内容卡片中的图片二进制数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。

若返回UDMF_ERR,表示内部数据错误。可能的原因是服务故障或者内存不足等。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_GetDescription()

PhonePC/2in1TabletTV
const char* OH_UdsContentForm_GetDescription(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回描述信息的字符串指针,否则返回nullptr。

OH_UdsContentForm_GetTitle()

PhonePC/2in1TabletTV
const char* OH_UdsContentForm_GetTitle(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回标题信息的字符串指针,否则返回nullptr。

OH_UdsContentForm_GetAppIcon()

PhonePC/2in1TabletTV
int OH_UdsContentForm_GetAppIcon(OH_UdsContentForm* pThis, unsigned char** appIcon, unsigned int* len)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
unsigned char** appIcon 该参数是输出参数,表示内容卡片中的应用图标二进制数据。
unsigned int* len 该参数是输出参数,表示内容卡片中的应用图标二进制数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。

若返回UDMF_ERR,表示内部数据错误。可能的原因是服务故障或者内存不足等。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_GetAppName()

PhonePC/2in1TabletTV
const char* OH_UdsContentForm_GetAppName(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回应用名称信息的字符串指针,否则返回nullptr。

OH_UdsContentForm_GetLinkUri()

PhonePC/2in1TabletTV
const char* OH_UdsContentForm_GetLinkUri(OH_UdsContentForm* pThis)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。

返回:

展开
类型 说明
const char* 输入有效入参时返回超链接的字符串指针,否则返回nullptr。

OH_UdsContentForm_SetThumbData()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetThumbData(OH_UdsContentForm* pThis, const unsigned char* thumbData, unsigned int len)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const unsigned char* thumbData 表示内容卡片中的图片二进制数据。
unsigned int len 表示内容卡片中的图片二进制数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_SetDescription()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetDescription(OH_UdsContentForm* pThis, const char* description)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const char* description 表示描述信息。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_SetTitle()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetTitle(OH_UdsContentForm* pThis, const char* title)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const char* title 表示标题信息。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_SetAppIcon()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetAppIcon(OH_UdsContentForm* pThis, const unsigned char* appIcon, unsigned int len)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const unsigned char* appIcon 表示内容卡片中的应用图标二进制数据。
unsigned int len 表示内容卡片中的应用图标二进制数据的大小。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_SetAppName()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetAppName(OH_UdsContentForm* pThis, const char* appName)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const char* appName 表示内容卡片中的应用名称。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsContentForm_SetLinkUri()

PhonePC/2in1TabletTV
int OH_UdsContentForm_SetLinkUri(OH_UdsContentForm* pThis, const char* linkUri)

描述

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

起始版本: 14

参数:

展开
参数项 描述
OH_UdsContentForm* pThis 表示指向OH_UdsContentForm实例的指针。
const char* linkUri 表示内容卡片中的超链接。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPlainText_GetDetails()

PhonePC/2in1TabletTV
int OH_UdsPlainText_GetDetails(OH_UdsPlainText* pThis, OH_UdsDetails* details)

描述

从纯文本类型OH_UdsPlainText中获取字典类型OH_UdsDetails实例的指针。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPlainText_SetDetails()

PhonePC/2in1TabletTV
int OH_UdsPlainText_SetDetails(OH_UdsPlainText* pThis, const OH_UdsDetails* details)

描述

设置纯文本类型OH_UdsPlainText中的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsPlainText* pThis 表示指向纯文本类型OH_UdsPlainText实例的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

PhonePC/2in1TabletTV
int OH_UdsHyperlink_GetDetails(OH_UdsHyperlink* pThis, OH_UdsDetails* details)

描述

从超链接类型OH_UdsHyperlink中获取字典类型OH_UdsDetails实例的指针。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

PhonePC/2in1TabletTV
int OH_UdsHyperlink_SetDetails(OH_UdsHyperlink* pThis, const OH_UdsDetails* details)

描述

设置超链接类型OH_UdsHyperlink实例中的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsHyperlink* pThis 表示指向超链接类型OH_UdsHyperlink实例的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsHtml_GetDetails()

PhonePC/2in1TabletTV
int OH_UdsHtml_GetDetails(OH_UdsHtml* pThis, OH_UdsDetails* details)

描述

从超文本标记语言类型OH_UdsHtml对象中获取字典类型OH_UdsDetails实例的指针。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsHtml_SetDetails()

PhonePC/2in1TabletTV
int OH_UdsHtml_SetDetails(OH_UdsHtml* pThis, const OH_UdsDetails* details)

描述

设置超文本标记语言类型OH_UdsHtml中的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向超文本标记语言类型OH_UdsHtml实例的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_GetDetails()

PhonePC/2in1TabletTV
int OH_UdsAppItem_GetDetails(OH_UdsAppItem* pThis, OH_UdsDetails* details)

描述

从桌面图标类型OH_UdsAppItem实例中获取字典类型OH_UdsDetails实例的指针。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsAppItem_SetDetails()

PhonePC/2in1TabletTV
int OH_UdsAppItem_SetDetails(OH_UdsAppItem* pThis, const OH_UdsDetails* details)

描述

设置桌面图标类型OH_UdsAppItem对象的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsAppItem* pThis 表示指向桌面图标类型OH_UdsAppItem对象的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsFileUri_GetDetails()

PhonePC/2in1TabletTV
int OH_UdsFileUri_GetDetails(OH_UdsFileUri* pThis, OH_UdsDetails* details)

描述

从文件Uri类型OH_UdsFileUri实例中获取字典类型OH_UdsDetails实例的指针。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsFileUri_SetDetails()

PhonePC/2in1TabletTV
int OH_UdsFileUri_SetDetails(OH_UdsFileUri* pThis, const OH_UdsDetails* details)

描述

设置文件Uri类型OH_UdsFileUri对象的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向文件Uri类型OH_UdsFileUri实例的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPixelMap_GetDetails()

PhonePC/2in1TabletTV
int OH_UdsPixelMap_GetDetails(OH_UdsPixelMap* pThis, OH_UdsDetails* details)

描述

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

起始版本: 22

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。
OH_UdsDetails* details 该参数是输出参数,表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsPixelMap_SetDetails()

PhonePC/2in1TabletTV
int OH_UdsPixelMap_SetDetails(OH_UdsPixelMap* pThis, const OH_UdsDetails* details)

描述

设置像素图片类型OH_UdsPixelMap对象的字典类型OH_UdsDetails参数。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsPixelMap* pThis 表示指向像素图片类型OH_UdsPixelMap实例的指针。
const OH_UdsDetails* details 表示指向字典类型OH_UdsDetails实例的指针,该指针不能为空。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsDetails_Create()

PhonePC/2in1TabletTV
OH_UdsDetails* OH_UdsDetails_Create()

描述

创建字典类型OH_UdsDetails指针及实例对象。

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

起始版本: 22

返回:

展开
类型 说明
OH_UdsDetails* 执行成功则返回一个指向字典类型OH_UdsDetails实例对象的指针,否则返回nullptr。

OH_UdsDetails_Destroy()

PhonePC/2in1TabletTV
void OH_UdsDetails_Destroy(OH_UdsDetails* pThis)

描述

销毁字典类型OH_UdsDetails指针指向的实例对象。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。

OH_UdsDetails_HasKey()

PhonePC/2in1TabletTV
bool OH_UdsDetails_HasKey(const OH_UdsDetails* pThis, const char* key)

描述

检查字典类型OH_UdsDetails中是否存在指定键。

起始版本: 22

参数:

展开
参数项 描述
const OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。
const char* key 表示字典类型中键值对的键。

返回:

展开
类型 说明
bool 返回查找结果的状态。返回false表示不存在指定键,返回true表示存在指定键。

OH_UdsDetails_Remove()

PhonePC/2in1TabletTV
int OH_UdsDetails_Remove(OH_UdsDetails* pThis, const char* key)

描述

删除字典类型OH_UdsDetails中指定键值对。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。
const char* key 表示字典类型中键值对的键。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsDetails_Clear()

PhonePC/2in1TabletTV
int OH_UdsDetails_Clear(OH_UdsDetails* pThis)

描述

清除字典类型OH_UdsDetails中所有数据。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsDetails_SetValue()

PhonePC/2in1TabletTV
int OH_UdsDetails_SetValue(OH_UdsDetails* pThis, const char* key, const char* value)

描述

向字典类型OH_UdsDetails中添加键值对数据。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。
const char* key 表示字典类型中键值对的键。
const char* value 表示字典类型中键值对的值。

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

OH_UdsDetails_GetValue()

PhonePC/2in1TabletTV
const char* OH_UdsDetails_GetValue(const OH_UdsDetails* pThis, const char* key)

描述

获取字典类型OH_UdsDetails中指定的键对应的值。

起始版本: 22

参数:

展开
参数项 描述
const OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。
const char* key 表示字典类型中键值对的键。

返回:

展开
类型 说明
const char* 当入参有效时返回指向字典类型中值的指针,否则返回nullptr。

OH_UdsDetails_GetAllKeys()

PhonePC/2in1TabletTV
char** OH_UdsDetails_GetAllKeys(OH_UdsDetails* pThis, unsigned int* count)

描述

获取字典类型OH_UdsDetails中所有键的结果集。

起始版本: 22

参数:

展开
参数项 描述
OH_UdsDetails* pThis 表示指向字典类型OH_UdsDetails实例的指针。
unsigned int* count 该参数是输出参数,表示结果集的长度。

返回:

展开
类型 说明
char**

执行成功时返回字典类型中键的结果集,否则返回nullptr。

当使用OH_UdsDetails_Destroy销毁字典类型OH_UdsDetails指针指向的实例对象,该返回值也会被释放。

OH_UdsHtml_SetAuthPolicy()Beta

PhonePC/2in1TabletTV
int OH_UdsHtml_SetAuthPolicy(OH_UdsHtml* pThis, uint32_t authPolicy)

描述

OH_UdsHtml设置授权策略。

说明

此授权策略仅在拖拽场景下生效,其他场景不生效。

起始版本: 26.0.0

参数:

展开
参数项 描述
OH_UdsHtml* pThis 表示指向OH_UdsHtml实例的指针。
uint32_t authPolicy 表示拖拽场景下的URI授权策略,默认值为READ(仅读授权),仅在img标签等场景下生效。只针对单个record使用,优先级最高。具体策略见Udmf_AuthPermission

返回:

展开
类型 说明
int

返回执行的状态代码。

返回UDMF_E_OK表示执行成功。

返回UDMF_E_INVALID_PARAM表示传入了无效参数。

具体请参见Udmf_ErrCode

OH_UdsFileUri_SetAuthPolicy()Beta

PhonePC/2in1TabletTV
int OH_UdsFileUri_SetAuthPolicy(OH_UdsFileUri* pThis, uint32_t authPolicy)

描述

OH_UdsFileUri设置授权策略。

说明

此授权策略仅在拖拽场景下生效,其他场景不生效。

起始版本: 26.0.0

参数:

展开
参数项 描述
OH_UdsFileUri* pThis 表示指向OH_UdsFileUri实例的指针。
uint32_t authPolicy 表示拖拽场景下的URI授权策略,默认值为READ+WRITE+PERSIST(读+写+持久化授权),只针对单个record使用,优先级最高。具体策略见Udmf_AuthPermission

返回:

展开
类型 说明
int

返回执行的状态代码。

若返回UDMF_E_OK,表示执行成功。

若返回UDMF_E_INVALID_PARAM,表示传入了无效参数。具体请参阅错误码定义Udmf_ErrCode

在 API参考 中进行搜索
请输入您想要搜索的关键词