1# oh_preferences_value.h
2
3
4## Overview
5
6Provides APIs, enums, and structs for accessing the **PreferencesValue** object.
7
8**File to include**: <database/preferences/oh_preferences_value.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 enum [Preference_ValueType](_preferences.md#preference_valuetype) [Preference_ValueType](_preferences.md#preference_valuetype) | Defines an enum for data types of **PreferencesValue**.|
27| typedef struct [OH_PreferencesPair](_preferences.md#oh_preferencespair) [OH_PreferencesPair](_preferences.md#oh_preferencespair) | Defines a Preferences data record in the key-value (KV) format.|
28| typedef struct [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) | Defines a **PreferencesValue** object.|
29
30
31### Enums
32
33| Name| Description|
34| -------- | -------- |
35| [Preference_ValueType](_preferences.md#preference_valuetype-1) {<br>PREFERENCE_TYPE_NULL = 0, PREFERENCE_TYPE_INT, PREFERENCE_TYPE_BOOL, PREFERENCE_TYPE_STRING,<br>PREFERENCE_TYPE_BUTT<br>} | Enumerates the data types of **PreferencesValue**.|
36
37
38### Functions
39
40| Name| Description|
41| -------- | -------- |
42| const char \* [OH_PreferencesPair_GetKey](_preferences.md#oh_preferencespair_getkey) (const [OH_PreferencesPair](_preferences.md#oh_preferencespair) \*pairs, uint32_t index) | Obtains the key based on the specified index from the KV data.|
43| const [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) \* [OH_PreferencesPair_GetPreferencesValue](_preferences.md#oh_preferencespair_getpreferencesvalue) (const [OH_PreferencesPair](_preferences.md#oh_preferencespair) \*pairs, uint32_t index) | Obtains the value based on the specified index from the KV pairs.|
44| [Preference_ValueType](_preferences.md#preference_valuetype) [OH_PreferencesValue_GetValueType](_preferences.md#oh_preferencesvalue_getvaluetype) (const [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) \*object) | Obtains the data type of a **PreferencesValue** instance.|
45| int [OH_PreferencesValue_GetInt](_preferences.md#oh_preferencesvalue_getint) (const [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) \*object, int \*value) | Obtains an integer value from an [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) instance.|
46| int [OH_PreferencesValue_GetBool](_preferences.md#oh_preferencesvalue_getbool) (const [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) \*object, bool \*value) | Obtains a Boolean value from an [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) instance.|
47| int [OH_PreferencesValue_GetString](_preferences.md#oh_preferencesvalue_getstring) (const [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) \*object, char \*\*value, uint32_t \*valueLen) | Obtains a string from an [OH_PreferencesValue](_preferences.md#oh_preferencesvalue) instance.|
48