Shared preference

Sifli Shared preference API. More...

Data Structures
struct	share_prefs_t
	Preference data type. More...
enum	share_prefs_mode {   SHAREPREFS_MODE_PRIVATE = 0x1,   SHAREPREFS_MODE_WORLD_READABLE = 0x2,   SHAREPREFS_MODE_WORLD_WRITEABLE = 0x4 }
	Preference mode enumeration. More...
share_prefs_t *	share_prefs_open (const char *prfs_name, uint32_t mode)
	share_prefs api More...
rt_err_t	share_prefs_close (share_prefs_t *prfs)
	Close shared preference database. More...
rt_err_t	share_prefs_clear (share_prefs_t *prfs)
	Clear shared preference database. More...
rt_err_t	share_prefs_remove (share_prefs_t *prfs, const char *key)
	Remove an entry for a preference database. More...
int32_t	share_prefs_get_int (share_prefs_t *prfs, const char *key, int32_t default_v)
	Get a integer type of a preference. More...
rt_err_t	share_prefs_set_int (share_prefs_t *prfs, const char *key, int32_t value)
	Set a integer type of a preference. More...
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. More...
rt_err_t	share_prefs_set_string (share_prefs_t *prfs, const char *key, const char *buf)
	Set a string type of a preference. More...
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. More...
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. More...
#define	SHARE_PREFS_MAX_NAME_LEN   32

Detailed Description

Sifli Shared preference API.

Enumeration Type Documentation

share_prefs_mode

enum share_prefs_mode

Preference mode enumeration.

Enumerator
SHAREPREFS_MODE_PRIVATE	Private
SHAREPREFS_MODE_WORLD_READABLE	Readable
SHAREPREFS_MODE_WORLD_WRITEABLE	Writable

Function Documentation

share_prefs_clear()

rt_err_t share_prefs_clear

(

share_prefs_t *

prfs

)

Clear shared preference database.

Parameters

[in]

prfs

Handle of shared preference database

Return values

RT_EOK

if successful, otherwise return error number <0

share_prefs_close()

rt_err_t share_prefs_close

(

share_prefs_t *

prfs

)

Close shared preference database.

Parameters

[in]

prfs

Handle of shared preference database

Return values

RT_EOK

if successful, otherwise return error number <0

share_prefs_get_block()

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.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in,out]	buf	Data buffer of preference value
[in]	buf_len	Max buffer length

Return values

Length

of buf if successful, otherwise return error number <0

share_prefs_get_int()

int32_t share_prefs_get_int	(	share_prefs_t *	prfs,
		const char *	key,
		int32_t	default_v
	)

Get a integer type of a preference.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in]	default_v	Default value if preference not found .

Return values

value

of interger

share_prefs_get_string()

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.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in,out]	buf	Data buffer of preference value
[in]	buf_len	Max buffer length

Return values

Length

of buf if successful, otherwise return error number <0

share_prefs_open()

share_prefs_t* share_prefs_open	(	const char *	prfs_name,
		uint32_t	mode
	)

share_prefs api

Open shared preference database

Parameters

[in]	prfs_name	Preference name
[in]	mode	Mode to open

Return values

Handle

of shared preference database

share_prefs_remove()

rt_err_t share_prefs_remove	(	share_prefs_t *	prfs,
		const char *	key
	)

Remove an entry for a preference database.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry

Return values

RT_EOK

if successful, otherwise return error number <0

share_prefs_set_block()

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.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in]	buf	Data buffer of preference value
[in]	buf_len	Buffer length

Return values

RT_EOK

if successful, otherwise return error number <0

share_prefs_set_int()

rt_err_t share_prefs_set_int	(	share_prefs_t *	prfs,
		const char *	key,
		int32_t	value
	)

Set a integer type of a preference.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in]	value	Value to be set

Return values

RT_EOK

if successful, otherwise return error number <0

share_prefs_set_string()

rt_err_t share_prefs_set_string	(	share_prefs_t *	prfs,
		const char *	key,
		const char *	buf
	)

Set a string type of a preference.

Parameters

[in]	prfs	Handle of shared preference database
[in]	key	Key name of preference entry
[in]	buf	Data buffer of preference value

Return values

RT_EOK

if successful, otherwise return error number <0