oh_preferences.h
概述
提供访问Preferences对象的接口与数据结构。
引用文件： <database/preferences/oh_preferences.h>
库： libohpreferences.so
系统能力： SystemCapability.DistributedDataManager.Preferences.Core
起始版本： 13
相关模块： Preferences
汇总
结构体
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| OH_Preferences | OH_Preferences | 定义Preferences对象类型。 |
函数
函数说明
OH_PreferencesDataObserver()
typedef void (*OH_PreferencesDataObserver)(void *context, const OH_PreferencesPair *pairs, uint32_t count)
描述
定义数据变更触发的回调函数类型。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| void *context | 应用上下文的指针。 |
| const OH_PreferencesPair *pairs | 发生变更的KV数据的指针。 |
| uint32_t count | 发生变更的KV数据的数量。 |
OH_Preferences_Open()
OH_Preferences *OH_Preferences_Open(OH_PreferencesOption *option, int *errCode)
描述
打开一个Preferences实例对象并创建指向它的指针。
当不再需要使用指针时，请使用OH_Preferences_Close关闭实例对象。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_PreferencesOption *option | 指向Preferences配置选项OH_PreferencesOption的指针。 |
| int *errCode | 该参数作为出参使用，表示指向返回错误码的指针，详见OH_Preferences_ErrCode。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_NOT_SUPPORTED，表示系统能力不支持。 若错误码为PREFERENCES_ERROR_DELETE_FILE，表示删除文件失败。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_Preferences | 当操作成功时，返回指向打开的Preferences对象OH_Preferences实例对象的指针，失败返回空指针。 |
OH_Preferences_Close()
int OH_Preferences_Close(OH_Preferences *preference)
描述
关闭一个Preferences实例对象。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向需要关闭的PreferencesOH_Preferences实例对象的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码，详见OH_Preferences_ErrCode。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
OH_Preferences_GetInt()
int OH_Preferences_GetInt(OH_Preferences *preference, const char *key, int *value)
描述
获取Preferences实例对象中Key对应的整型值。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 需要获取的Key的指针。 |
| int *value | 该参数作为出参使用，表示指向获取到的整型值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 若错误码为PREFERENCES_ERROR_KEY_NOT_FOUND，表示查询的Key不存在。 |
OH_Preferences_GetBool()
int OH_Preferences_GetBool(OH_Preferences *preference, const char *key, bool *value)
描述
获取Preferences实例对象中Key对应的布尔值。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 需要获取的Key的指针。 |
| bool *value | 该参数作为出参使用，表示指向获取到的布尔值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 若错误码为PREFERENCES_ERROR_KEY_NOT_FOUND，表示查询的key不存在。 |
OH_Preferences_GetString()
int OH_Preferences_GetString(OH_Preferences *preference, const char *key, char **value, uint32_t *valueLen)
描述
获取Preferences实例对象中Key对应的字符串。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 需要获取的Key的指针。 |
| char **value | 该参数作为出参使用，表示指向获取到的字符串的二级指针，使用完毕后需要调用释放函数OH_Preferences_FreeString释放内存。 |
| uint32_t *valueLen | 该参数作为出参使用，表示获取到的字符串长度的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 若错误码为PREFERENCES_ERROR_KEY_NOT_FOUND，表示查询的Key不存在。 |
OH_Preferences_FreeString()
void OH_Preferences_FreeString(char *string)
描述
释放从Preferences实例对象中获取的字符串。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| char *string | 需要释放的字符串指针。 |
OH_Preferences_SetInt()
int OH_Preferences_SetInt(OH_Preferences *preference, const char *key, int value)
描述
根据Key设置Preferences实例对象中的整型值。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 指向需要设置的Key的指针。 |
| int value | 需要设置的整型值。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
OH_Preferences_SetBool()
int OH_Preferences_SetBool(OH_Preferences *preference, const char *key, bool value)
描述
根据Key设置Preferences实例对象中的布尔值。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 指向需要设置的Key的指针。 |
| bool value | 需要设置的布尔值。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
OH_Preferences_SetString()
int OH_Preferences_SetString(OH_Preferences *preference, const char *key, const char *value)
描述
根据Key设置Preferences实例对象中的字符串。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 指向需要设置的Key的指针。 |
| const char *value | 指向需要设置的字符串指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
OH_Preferences_Delete()
int OH_Preferences_Delete(OH_Preferences *preference, const char *key)
描述
在Preferences实例对象中删除Key对应的KV数据。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| const char *key | 指向需要删除的Key的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
参考：
OH_Preferences_ErrCode
OH_Preferences_RegisterDataObserver()
int OH_Preferences_RegisterDataObserver(OH_Preferences *preference, void *context,OH_PreferencesDataObserver observer, const char *keys[], uint32_t keyCount)
描述
对选取的Key注册数据变更订阅。订阅的Key的值发生变更后，在调用OH_Preferences_Close()后触发回调。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| void *context | 应用上下文的指针。 |
| OH_PreferencesDataObserver observer | 订阅数据变更关联的回调函数OH_PreferencesDataObserver。 |
| const char *keys[] | 需要订阅的Key数组。 |
| uint32_t keyCount | 需要订阅的Key的数量。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 若错误码为PREFERENCES_ERROR_GET_DATAOBSMGRCLIENT，表示获取数据变更订阅服务失败。 |
OH_Preferences_UnregisterDataObserver()
int OH_Preferences_UnregisterDataObserver(OH_Preferences *preference, void *context,OH_PreferencesDataObserver observer, const char *keys[], uint32_t keyCount)
描述
取消注册选取Key的数据变更订阅。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| OH_Preferences *preference | 指向目标PreferencesOH_Preferences实例对象的指针。 |
| void *context | 应用上下文的指针。 |
| OH_PreferencesDataObserver observer | 订阅数据变更关联的回调函数OH_PreferencesDataObserver。 |
| const char *keys[] | 需要取消订阅的Key数组。 |
| uint32_t keyCount | 需要取消订阅的Key的数量。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回执行的错误码。 若错误码为PREFERENCES_OK，表示操作成功。 若错误码为PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 若错误码为PREFERENCES_ERROR_STORAGE，表示存储异常。 若错误码为PREFERENCES_ERROR_MALLOC，表示内存分配失败。 |
参考：
OH_Preferences_ErrCode
OH_Preferences_IsStorageTypeSupported()
int OH_Preferences_IsStorageTypeSupported(Preferences_StorageType type, bool *isSupported)
起始版本： 18
参数：
| 参数项 | 描述 |
|---|---|
| Preferences_StorageType type | 要校验是否支持的存储模式。 |
| bool *isSupported | 校验结果的指针，作为出参使用。true表示当前平台支持当前校验的存储模式，false表示当前平台不支持当前校验的存储模式。 |
返回：
| 类型 | 说明 |
|---|---|
| int | 返回接口操作执行的状态码。 PREFERENCES_OK，表示操作成功。 PREFERENCES_ERROR_INVALID_PARAM，表示参数不合法。 |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙Class (RdbPredicates)
harmony 鸿蒙arkts-apis-data-relationalStore-RdbStore
harmony 鸿蒙Interface (ResultSet)