GGiteeupdate
44def595创建于 2024年12月19日历史提交

uds.h

概述

提供标准化数据结构相关接口函数、结构体定义。

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

库: libudmf.so

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

起始版本: 12

相关模块:UDMF

汇总

类型定义

名称 描述
typedef struct OH_UdsPlainText OH_UdsPlainText 描述纯文本类型数据的统一数据结构。
typedef struct OH_UdsHyperlink OH_UdsHyperlink 描述超链接类型的统一数据结构。
typedef struct OH_UdsHtml OH_UdsHtml 描述超文本标记语言类型的统一数据结构。
typedef struct OH_UdsAppItem OH_UdsAppItem 描述桌面图标类型的统一数据结构。
typedef struct OH_UdsFileUri OH_UdsFileUri 描述文件Uri类型的统一数据结构。
typedef struct OH_UdsPixelMap OH_UdsPixelMap 描述像素图片类型的统一数据结构。
typedef struct OH_UdsArrayBuffer OH_UdsArrayBuffer 描述ArrayBuffer类型的统一数据结构。
typedef struct OH_UdsContentForm OH_UdsContentForm 描述内容卡片类型的统一数据结构。

函数

名称 描述
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指针及实例对象
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中的超链接数据。