share_prefs.h
Sifli Shared preference API.
- Author
Sifli software development team
Unnamed Group
-
SHARE_PREFS_MAX_NAME_LEN
-
enum share_prefs_mode
Preference mode enumeration.
Values:
-
enumerator SHAREPREFS_MODE_PRIVATE
Private
-
enumerator SHAREPREFS_MODE_WORLD_READABLE
Readable
-
enumerator SHAREPREFS_MODE_WORLD_WRITEABLE
Writable
-
enumerator SHAREPREFS_MODE_PRIVATE
-
share_prefs_t *share_prefs_open(const char *prfs_name, uint32_t mode)
share_prefs api
Open shared preference database
- 参数:
prfs_name – [in] Preference name
mode – [in] Mode to open
- 返回值:
Handle – of shared preference database
-
rt_err_t share_prefs_close(share_prefs_t *prfs)
Close shared preference database.
- 参数:
prfs – [in] Handle of shared preference database
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
rt_err_t share_prefs_clear(share_prefs_t *prfs)
Clear shared preference database.
- 参数:
prfs – [in] Handle of shared preference database
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
rt_err_t share_prefs_remove(share_prefs_t *prfs, const char *key)
Remove an entry for a preference database.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
int32_t share_prefs_get_int(share_prefs_t *prfs, const char *key, int32_t default_v)
Get a integer type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
default_v – [in] Default value if preference not found .
- 返回值:
value – of interger
-
rt_err_t share_prefs_set_int(share_prefs_t *prfs, const char *key, int32_t value)
Set a integer type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
value – [in] Value to be set
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
int32_t share_prefs_get_string(share_prefs_t *prfs, const char *key, char *buf, int32_t buf_len)
Get a string type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
buf – [inout] Data buffer of preference value
buf_len – [in] Max buffer length
- 返回值:
Length – of buf if successful, otherwise return error number <0
-
rt_err_t share_prefs_set_string(share_prefs_t *prfs, const char *key, const char *buf)
Set a string type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
buf – [in] Data buffer of preference value
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
int32_t share_prefs_get_block(share_prefs_t *prfs, const char *key, void *buf, int32_t buf_len)
Get a general block type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
buf – [inout] Data buffer of preference value
buf_len – [in] Max buffer length
- 返回值:
Length – of buf if successful, otherwise return error number <0
-
rt_err_t share_prefs_set_block(share_prefs_t *prfs, const char *key, const void *buf, int32_t buf_len)
Set a general block type of a preference.
- 参数:
prfs – [in] Handle of shared preference database
key – [in] Key name of preference entry
buf – [in] Data buffer of preference value
buf_len – [in] Buffer length
- 返回值:
RT_EOK – if successful, otherwise return error number <0
-
struct share_prefs_t
- #include <share_prefs.h>
Preference data type.