• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_preferences_option.h
2
3
4## 概述
5
6提供访问Preferences配置选项（PreferencesOption）的接口与数据结构。
7
8**引用文件：**<database/preferences/oh_preferences_option.h>
9
10**库：** libohpreferences.so
11
12**系统能力：** SystemCapability.DistributedDataManager.Preferences.Core
13
14**起始版本：** 13
15
16**相关模块：**[Preferences](_preferences.md)
17
18
19## 汇总
20
21
22### 类型定义
23
24| 名称 | 描述 |
25| -------- | -------- |
26| typedef struct [OH_PreferencesOption](_preferences.md#oh_preferencesoption) [OH_PreferencesOption](_preferences.md#oh_preferencesoption) | 定义Preferences配置选项的数据结构。 |
27| typedef enum [Preferences_StorageType](_preferences.md#preferences_storagetype) [Preferences_StorageType](_preferences.md#preferences_storagetype) | 首选项配置选项的存储模式枚举。  |
28
29### 枚举
30
31| 名称 | 描述 |
32| -------- | -------- |
33| [Preferences_StorageType](_preferences.md#preferences_storagetype-1) { PREFERENCES_STORAGE_XML = 0, PREFERENCES_STORAGE_GSKV } | 首选项配置选项的存储模式枚举。  |
34
35### 函数
36
37| 名称 | 描述 |
38| -------- | -------- |
39| int [OH_PreferencesOption_SetStorageType](_preferences.md#oh_preferencesoption_setstoragetype) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, [Preferences_StorageType](_preferences.md#preferences_storagetype) type) | 设置Preferences实例对象的存储模式。  |
40| [OH_PreferencesOption](_preferences.md#oh_preferencesoption) \* [OH_PreferencesOption_Create](_preferences.md#oh_preferencesoption_create) (void) | 创建一个Preferences配置选项的[OH_PreferencesOption](_preferences.md#oh_preferencesoption)实例对象以及指向它的指针。 当不再需要使用指针时，请使用[OH_PreferencesOption_Destroy](_preferences.md#oh_preferencesoption_destroy)销毁实例对象，否则会导致内存泄漏。 |
41| int [OH_PreferencesOption_SetFileName](_preferences.md#oh_preferencesoption_setfilename) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*fileName) | 设置Preferences配置选项[OH_PreferencesOption](_preferences.md#oh_preferencesoption)实例对象的文件名称。 |
42| int [OH_PreferencesOption_SetBundleName](_preferences.md#oh_preferencesoption_setbundlename) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*bundleName) | 设置Preferences配置选项[OH_PreferencesOption](_preferences.md#oh_preferencesoption)实例对象的包名称。 |
43| int [OH_PreferencesOption_SetDataGroupId](_preferences.md#oh_preferencesoption_setdatagroupid) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*dataGroupId) | 设置Preferences配置选项[OH_PreferencesOption](_preferences.md#oh_preferencesoption)实例对象的应用组ID。 |
44| int [OH_PreferencesOption_Destroy](_preferences.md#oh_preferencesoption_destroy) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option) | 销毁Preferences配置选项[OH_PreferencesOption](_preferences.md#oh_preferencesoption)实例。 |
45