• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_preferences_option.h
2
3
4## Overview
5
6Provides APIs and structs for accessing the **PreferencesOption** object.
7
8**File to include**: <database/preferences/oh_preferences_option.h>
9
10**Library**: libohpreferences.so
11
12**System capability**: SystemCapability.DistributedDataManager.Preferences.Core
13
14**Since**: 13
15
16Related module: [Preferences](_preferences.md)
17
18
19## Summary
20
21
22### Types
23
24| Name| Description|
25| -------- | -------- |
26| typedef struct [OH_PreferencesOption](_preferences.md#oh_preferencesoption) [OH_PreferencesOption](_preferences.md#oh_preferencesoption) | Defines a **PreferencesOption** object.|
27| typedef enum [Preferences_StorageType](_preferences.md#preferences_storagetype) [Preferences_StorageType](_preferences.md#preferences_storagetype) | Defines an enum for preferences storage types. |
28
29### Enums
30
31| Name| Description|
32| -------- | -------- |
33| [Preferences_StorageType](_preferences.md#preferences_storagetype-1) { PREFERENCES_STORAGE_XML = 0, PREFERENCES_STORAGE_GSKV } | Enumerates the preferences storage types. |
34
35### Functions
36
37| Name| Description|
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) | Sets the storage type for a preferences instance. |
40| [OH_PreferencesOption](_preferences.md#oh_preferencesoption) \* [OH_PreferencesOption_Create](_preferences.md#oh_preferencesoption_create) (void) | Creates an [OH_PreferencesOption](_preferences.md#oh_preferencesoption) instance and a pointer to it. If this pointer is no longer required, use [OH_PreferencesOption_Destroy](_preferences.md#oh_preferencesoption_destroy) to destroy it. Otherwise, memory leaks may occur.|
41| int [OH_PreferencesOption_SetFileName](_preferences.md#oh_preferencesoption_setfilename) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*fileName) | Sets the file name for an [OH_PreferencesOption](_preferences.md#oh_preferencesoption) instance.|
42| int [OH_PreferencesOption_SetBundleName](_preferences.md#oh_preferencesoption_setbundlename) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*bundleName) | Sets the bundle name for an [OH_PreferencesOption](_preferences.md#oh_preferencesoption) instance.|
43| int [OH_PreferencesOption_SetDataGroupId](_preferences.md#oh_preferencesoption_setdatagroupid) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option, const char \*dataGroupId) | Sets the application group ID for an [OH_PreferencesOption](_preferences.md#oh_preferencesoption) instance.|
44| int [OH_PreferencesOption_Destroy](_preferences.md#oh_preferencesoption_destroy) ([OH_PreferencesOption](_preferences.md#oh_preferencesoption) \*option) | Destroys an [OH_PreferencesOption](_preferences.md#oh_preferencesoption) instance.|
45