harmony 鸿蒙oh_preferences_option.h

  • 2025-06-12
  • 浏览 (25)

oh_preferences_option.h

概述

提供访问Preferences配置选项（PreferencesOption）的接口与数据结构。

引用文件：

库： libohpreferences.so

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

起始版本： 13

相关模块： Preferences

汇总

结构体

名称 typedef关键字 描述
OH_PreferencesOption OH_PreferencesOption 定义Preferences配置选项的数据结构。

枚举

名称 typedef关键字 描述
Preferences_StorageType Preferences_StorageType 首选项配置选项的存储模式枚举。

函数

名称 描述
OH_PreferencesOption *OH_PreferencesOption_Create(void) 创建一个Preferences配置选项的OH_PreferencesOption实例对象以及指向它的指针。
当不再需要使用指针时，请使用OH_PreferencesOption_Destroy销毁实例对象，否则会导致内存泄漏。
int OH_PreferencesOption_SetFileName(OH_PreferencesOption *option, const char *fileName) 设置Preferences配置选项OH_PreferencesOption实例对象的文件名称。
int OH_PreferencesOption_SetBundleName(OH_PreferencesOption *option, const char *bundleName) 设置Preferences配置选项OH_PreferencesOption实例对象的包名称。
int OH_PreferencesOption_SetDataGroupId(OH_PreferencesOption *option, const char *dataGroupId) 设置Preferences配置选项OH_PreferencesOption实例对象的应用组ID。
设置应用组ID后，会指定在此应用组ID对应的沙箱路径下创建Preferences实例。应用组ID需要向应用市场获取，暂不支持。
当传入的应用组ID为空字符串时，默认在本应用沙箱目录下创建Preferences实例。
int OH_PreferencesOption_SetStorageType(OH_PreferencesOption *option, Preferences_StorageType type) 设置Preferences实例对象的存储模式。
int OH_PreferencesOption_Destroy(OH_PreferencesOption *option) 销毁Preferences配置选项OH_PreferencesOption实例。

枚举类型说明

Preferences_StorageType

enum Preferences_StorageType

描述

首选项配置选项的存储模式枚举。

起始版本： 18

枚举项 描述
PREFERENCES_STORAGE_XML = 0 XML存储模式，对数据的操作发生在内存中，调用OH_Preferences_Close时落盘，不支持多进程。
PREFERENCES_STORAGE_GSKV GSKV存储模式，对数据的操作实时落盘，可支持多进程

函数说明

OH_PreferencesOption_Create()

OH_PreferencesOption *OH_PreferencesOption_Create(void)

描述

创建一个Preferences配置选项的OH_PreferencesOption实例对象以及指向它的指针。
当不再需要使用指针时，请使用OH_PreferencesOption_Destroy销毁实例对象，否则会导致内存泄漏。

起始版本： 13

返回：

类型 说明
OH_PreferencesOption 如果操作成功，返回指向Preferences配置选项OH_PreferencesOption实例对象的指针。失败返回空指针。

OH_PreferencesOption_SetFileName()

int OH_PreferencesOption_SetFileName(OH_PreferencesOption *option, const char *fileName)

描述

设置Preferences配置选项OH_PreferencesOption实例对象的文件名称。

起始版本： 13

参数：

参数项 描述
OH_PreferencesOption *option 指向Preferences配置选项OH_PreferencesOption实例对象的指针。
const char *fileName 需要设置的文件名称。

返回：

类型 说明
int 返回执行的错误码。
若错误码为PREFERENCES_OK，表示操作成功。
若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。

参考：

OH_Preferences_ErrCode

OH_PreferencesOption_SetBundleName()

int OH_PreferencesOption_SetBundleName(OH_PreferencesOption *option, const char *bundleName)

描述

设置Preferences配置选项OH_PreferencesOption实例对象的包名称。

起始版本： 13

参数：

参数项 描述
OH_PreferencesOption *option 配置选项OH_PreferencesOption实例对象的指针。
const char *bundleName 需要设置的包名称。

返回：

类型 说明
int 返回执行的错误码。
若错误码为PREFERENCES_OK，表示操作成功。
若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。

OH_PreferencesOption_SetDataGroupId()

int OH_PreferencesOption_SetDataGroupId(OH_PreferencesOption *option, const char *dataGroupId)

描述

设置Preferences配置选项OH_PreferencesOption实例对象的应用组ID。
设置应用组ID后，会指定在此应用组ID对应的沙箱路径下创建Preferences实例。应用组ID需要向应用市场获取，暂不支持。
当传入的应用组ID为空字符串时，默认在本应用沙箱目录下创建Preferences实例。

起始版本： 13

参数：

参数项 描述
OH_PreferencesOption *option 配置选项OH_PreferencesOption实例对象的指针。
const char *dataGroupId 需要设置的应用组ID。

返回：

类型 说明
int 返回执行的错误码。
若错误码为PREFERENCES_OK，表示操作成功。
若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。

OH_PreferencesOption_SetStorageType()

int OH_PreferencesOption_SetStorageType(OH_PreferencesOption *option, Preferences_StorageType type)

描述

设置Preferences实例对象的存储模式。

起始版本： 18

参数：

参数项 描述
OH_PreferencesOption *option 指向要设置存储模式的配置项的指针。
Preferences_StorageType type 需要设置的存储模式。

返回：

类型 说明
int 返回执行的错误码。
若错误码为PREFERENCES_OK，表示操作成功。
若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。

OH_PreferencesOption_Destroy()

int OH_PreferencesOption_Destroy(OH_PreferencesOption *option)

描述

销毁Preferences配置选项OH_PreferencesOption实例。

起始版本： 13

参数：

参数项 描述
OH_PreferencesOption *option 配置选项OH_PreferencesOption实例对象的指针。

返回：

类型 说明
int 返回接口操作执行的状态码。
PREFERENCES_OK，表示操作成功。
PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkData（方舟数据管理）

harmony 鸿蒙Class (RdbPredicates)

harmony 鸿蒙arkts-apis-data-relationalStore-RdbStore

harmony 鸿蒙Interface (ResultSet)

harmony 鸿蒙Interface (Transaction)

harmony 鸿蒙Enums

harmony 鸿蒙Functions

harmony 鸿蒙Interfaces (其他)

harmony 鸿蒙Types

harmony 鸿蒙模块描述

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/T3BTpS
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录