Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

Global Settings


Data Structures

struct  _AlpGlobalSettingsValue
struct  _AlpGlobalSettingsEntry

Defines

#define ALP_GLOBAL_SETTINGS_RPC
#define ALP_GLOBAL_SETTINGS_VERSION   1
#define GLOBAL_SETTINGS_APP_ID   "com.access.sys.global_settings"
#define GLOBAL_SETTINGS_CHANNEL_NAME   "global settings"
#define GLOBAL_SETTINGS_TIMEOUT   500000
#define ALP_NOTIFY_EVENT_GLOBAL_SETTINGS_KEY_CHANGE   "/alp/globalsettings/keychange"
#define ALP_STATUS_GLOBAL_SETTINGS_ERROR   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00010000)
#define ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00020000)
#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_FOUND   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00030000)
#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_ITERATOR_AT_END   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00040000)
#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_ITERATOR_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00050000)
#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_DIR   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00060000)
#define ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00070000)
#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00080000)
#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00090000)
#define ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000a0000)
#define ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000b0000)
#define ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000c0000)
#define ALP_STATUS_GLOBAL_SETTINGS_KEY_EXISTS   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000d0000)
#define ALP_STATUS_GLOBAL_SETTINGS_VERSION_MISMATCH   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000e0000)
#define GLOBAL_SETTINGS_VALUE_INITIALIZER   { ALP_GLOBAL_SETTINGS_TYPE_INVALID, 0, 0, 0, 0, 0, { 0, 0 } }

Typedefs

typedef _AlpGlobalSettingsContext AlpGlobalSettingsContext
 Opaque type for representing a preference service instance.
typedef _AlpGlobalSettingsValue AlpGlobalSettingsValue
 type for representing a preference value; must be initialized to 0 before use
typedef _AlpGlobalSettingsEntry AlpGlobalSettingsEntry
 a simple key-value preference entry; must be initialized to 0 before use
typedef _AlpGlobalSettingsEntryIterator AlpGlobalSettingsEntryIterator
 the iterator for traversing a dir tree key value

Enumerations

enum  AlpGlobalSettingsValueType {
  ALP_GLOBAL_SETTINGS_TYPE_INVALID = 0, ALP_GLOBAL_SETTINGS_TYPE_STRING, ALP_GLOBAL_SETTINGS_TYPE_INT, ALP_GLOBAL_SETTINGS_TYPE_FLOAT,
  ALP_GLOBAL_SETTINGS_TYPE_BOOL, ALP_GLOBAL_SETTINGS_TYPE_LIST, ALP_GLOBAL_SETTINGS_TYPE_DIR, ALP_GLOBAL_SETTINGS_TYPE_BLOB
}
 enums for types of preference values More...

Functions

AlpGlobalSettingsEntryalp_global_settings_entry_alloc (void)
 allocate a new entry struct
void alp_global_settings_entry_free (AlpGlobalSettingsEntry *e)
 decllocates a previously allocated entry object
AlpGlobalSettingsValuealp_global_settings_value_alloc (void)
 allocate a new value struct
void alp_global_settings_value_free (AlpGlobalSettingsValue *e)
 decllocates a previously allocated value object
void alp_global_settings_value_clean (AlpGlobalSettingsValue *e)
 decllocates resources used by a value object but not the value object itself
void alp_global_settings_value_list_free (GList *l)
 decllocates a list of value obbjects; the list is used to represent a list value
alp_status_t alp_global_settings_init (void)
 initialize the Global Settings system
alp_status_t alp_global_settings_open (AlpGlobalSettingsContext **context)
 obtain the preference service
alp_status_t alp_global_settings_close (AlpGlobalSettingsContext *context)
 frees the reference to the preference service
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_begin_transaction (AlpGlobalSettingsContext *context)
 begins a transaction in which all changes will occur in one shot automatically
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_complete_transaction (AlpGlobalSettingsContext *context)
 commits a transaction which has accumulated a serious of previous write commands
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_cancel_transaction (AlpGlobalSettingsContext *context)
 cancels a transaction which has accumulated a serious of previous write commands
alp_status_t alp_global_settings_set_cwd (AlpGlobalSettingsContext *context, const char *cwd)
 set the current "directory" in the key space then following key paths which are not absolute will be treated as relative to the "directory"
alp_status_t alp_global_settings_get_cwd (AlpGlobalSettingsContext *context, char *buf, size_t buf_size)
 get the current "directory" in the key space then following key paths which are not absolute are treated as relative to the "directory"
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_default_mode (AlpGlobalSettingsContext *context, mode_t mode)
 set the permission used when creating new keys
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_default_mode (AlpGlobalSettingsContext *context, mode_t *mode)
 get the permission used when creating new keys
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_mode (AlpGlobalSettingsContext *context, const char *key, mode_t mode)
 set the permission on an existing key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_mode (AlpGlobalSettingsContext *context, const char *key, mode_t *mode)
 get the permission on an existing key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_uid (AlpGlobalSettingsContext *context, const char *key, uid_t id)
 set the user id on an existing key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_uid (AlpGlobalSettingsContext *context, const char *key, uid_t *id)
 get the current user id of a key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_gid (AlpGlobalSettingsContext *context, const char *key, gid_t id)
 set the group id of an existing key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_gid (AlpGlobalSettingsContext *context, const char *key, gid_t *id)
 get the group id of an existing key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set (AlpGlobalSettingsContext *context, const char *key, const AlpGlobalSettingsValue *value)
 set the value of a key; a new key is created if the key does not exist and the old value is overwritten if the key already exists
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get (AlpGlobalSettingsContext *context, const char *key, AlpGlobalSettingsValue *value)
 get the current value of a key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete (AlpGlobalSettingsContext *context, const char *key)
 deletes the current key setting, and reverts the key value to default if there is one
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete_tree (AlpGlobalSettingsContext *context, const char *key)
 deletes the all keys (subtree) below a given key as well as that key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete_tree_keeping_defaults (AlpGlobalSettingsContext *context, const char *key)
 deletes the all keys (subtree) below a given key as well as that key, except keeping default keys intact
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_type (AlpGlobalSettingsContext *context, const char *key, AlpGlobalSettingsValueType *type)
 get the type of the value of a key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_value_size (AlpGlobalSettingsContext *context, const char *key, size_t *size)
 get the type of the value of a key
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_notification_on_off (AlpGlobalSettingsContext *context, int on_off)
 set the key change notification to be on or off
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_findkeys_start (AlpGlobalSettingsContext *context, const char *dir_path, AlpGlobalSettingsEntryIterator **iterator)
 begin the traversal of the value of a key which is a list of subkeys
alp_status_t alp_global_settings_findkeys_next (AlpGlobalSettingsEntryIterator *iterator)
 advances the iterator to the next key in the list
alp_status_t alp_global_settings_findkeys_end (AlpGlobalSettingsEntryIterator *iterator)
 completes the traversal represented by the iterator; the associated resources are freed
alp_status_t alp_global_settings_findkeys_get_key (AlpGlobalSettingsEntryIterator *iterator, char *key, unsigned int key_size)
 returns the key of the key pointed by an iterator separately
alp_status_t alp_global_settings_entry_get_key_value (const AlpGlobalSettingsEntry *entry, char *key, unsigned int key_size, AlpGlobalSettingsValue *value)
 returns the key and the value of the key of an value entry
alp_status_t alp_global_settings_entry_set_key_value (AlpGlobalSettingsEntry *entry, const char *key, const AlpGlobalSettingsValue *value)
 sets the key and the value of the key of an value entry; old resources are freed, if exist
alp_status_t alp_global_settings_value_set_string (AlpGlobalSettingsValue *value, const char *string)
 set a string preference value; the old value, if any, is freed
alp_status_t alp_global_settings_value_set_int (AlpGlobalSettingsValue *value, int i)
 create an integer preference value; the old value, if any, is freed
alp_status_t alp_global_settings_value_set_float (AlpGlobalSettingsValue *value, double f)
 create a float preference value; the old value, if any, is freed
alp_status_t alp_global_settings_value_set_bool (AlpGlobalSettingsValue *value, gboolean b)
 create a bool preference value; the old value, if any, is freed
alp_status_t alp_global_settings_value_set_list (AlpGlobalSettingsValue *value, const GList *list)
 set a list (dir) preference value; the old value, if any, is freed
alp_status_t alp_global_settings_value_get_string (AlpGlobalSettingsValue *value, char *string, unsigned int string_size)
 get the string preference value contained in an value object
alp_status_t alp_global_settings_value_get_int (AlpGlobalSettingsValue *value, int *i)
 get the integer preference value contained in an value object
alp_status_t alp_global_settings_value_get_float (AlpGlobalSettingsValue *value, double *f)
 get the float preference value contained in an value object
alp_status_t alp_global_settings_value_get_bool (AlpGlobalSettingsValue *value, gboolean *b)
 get the boolean preference value contained in an value object
alp_status_t alp_global_settings_value_get_list (AlpGlobalSettingsValue *value, GList **list)
 get the dir (list) preference value contained in an value object
alp_status_t alp_global_settings_get_key_string_value (AlpGlobalSettingsContext *context, const char *key, char *value, unsigned int value_size)
 get a string key-value pair
alp_status_t alp_global_settings_set_key_string_value (AlpGlobalSettingsContext *context, const char *key, const char *value)
 set a string key-value pair
alp_status_t alp_global_settings_get_key_bool_value (AlpGlobalSettingsContext *context, const char *key, gboolean *value)
 get a boolean key-value pair
alp_status_t alp_global_settings_set_key_bool_value (AlpGlobalSettingsContext *context, const char *key, gboolean value)
 set a boolean key-value pair
alp_status_t alp_global_settings_get_key_int_value (AlpGlobalSettingsContext *context, const char *key, int *value)
 get an integer key-value pair
alp_status_t alp_global_settings_set_key_int_value (AlpGlobalSettingsContext *context, const char *key, int value)
 set an integer key-value pair
alp_status_t alp_global_settings_get_key_float_value (AlpGlobalSettingsContext *context, const char *key, double *value)
 get a float key-value pair
alp_status_t alp_global_settings_set_key_float_value (AlpGlobalSettingsContext *context, const char *key, double value)
 set a float
alp_status_t alp_global_settings_get_key_blob_value (AlpGlobalSettingsContext *context, const char *key, char *value, int buffer_size, int *value_size)
 get a Blob key-value pair
alp_status_t alp_global_settings_set_key_blob_value (AlpGlobalSettingsContext *context, const char *key, const char *value, int value_size)
 set a float
alp_status_t alp_global_settings_set_key_directory (AlpGlobalSettingsContext *context, const char *key)
 create a directory: this call fails if a key with the same name already exists
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_import_from_file (AlpGlobalSettingsContext *context, const char *file)
 to install a set of preferences from an XML file en masse
ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_list_keys (AlpGlobalSettingsContext *context, const gchar *pattern, AlpGlobalSettingsEntryIterator **iterator)
 get back a list of keys according to a glob pattern


Define Documentation

#define ALP_GLOBAL_SETTINGS_RPC
 

#define ALP_GLOBAL_SETTINGS_VERSION   1
 

#define ALP_NOTIFY_EVENT_GLOBAL_SETTINGS_KEY_CHANGE   "/alp/globalsettings/keychange"
 

#define ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000a0000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000b0000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00080000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_ITERATOR_AT_END   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00040000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_ENTRY_ITERATOR_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00050000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_ERROR   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00010000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00070000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_KEY_EXISTS   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000d0000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00020000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000c0000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00090000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_DIR   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00060000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_FOUND   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x00030000)
 

#define ALP_STATUS_GLOBAL_SETTINGS_VERSION_MISMATCH   ((alp_status_t) ALP_CLASS_GLOBAL_SETTINGS | 0x000e0000)
 

#define GLOBAL_SETTINGS_APP_ID   "com.access.sys.global_settings"
 

#define GLOBAL_SETTINGS_CHANNEL_NAME   "global settings"
 

#define GLOBAL_SETTINGS_TIMEOUT   500000
 

#define GLOBAL_SETTINGS_VALUE_INITIALIZER   { ALP_GLOBAL_SETTINGS_TYPE_INVALID, 0, 0, 0, 0, 0, { 0, 0 } }
 


Typedef Documentation

typedef struct _AlpGlobalSettingsContext AlpGlobalSettingsContext
 

Opaque type for representing a preference service instance.

typedef struct _AlpGlobalSettingsEntry AlpGlobalSettingsEntry
 

a simple key-value preference entry; must be initialized to 0 before use

typedef struct _AlpGlobalSettingsEntryIterator AlpGlobalSettingsEntryIterator
 

the iterator for traversing a dir tree key value

typedef struct _AlpGlobalSettingsValue AlpGlobalSettingsValue
 

type for representing a preference value; must be initialized to 0 before use


Enumeration Type Documentation

enum AlpGlobalSettingsValueType
 

enums for types of preference values

Enumerator:
ALP_GLOBAL_SETTINGS_TYPE_INVALID 
ALP_GLOBAL_SETTINGS_TYPE_STRING 
ALP_GLOBAL_SETTINGS_TYPE_INT 
ALP_GLOBAL_SETTINGS_TYPE_FLOAT 
ALP_GLOBAL_SETTINGS_TYPE_BOOL 
ALP_GLOBAL_SETTINGS_TYPE_LIST 
ALP_GLOBAL_SETTINGS_TYPE_DIR 
ALP_GLOBAL_SETTINGS_TYPE_BLOB 


Function Documentation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_begin_transaction AlpGlobalSettingsContext context  ) 
 

begins a transaction in which all changes will occur in one shot automatically

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_cancel_transaction AlpGlobalSettingsContext context  ) 
 

cancels a transaction which has accumulated a serious of previous write commands

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_close AlpGlobalSettingsContext context  ) 
 

frees the reference to the preference service

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_ERROR on failure

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_complete_transaction AlpGlobalSettingsContext context  ) 
 

commits a transaction which has accumulated a serious of previous write commands

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete AlpGlobalSettingsContext context,
const char *  key
 

deletes the current key setting, and reverts the key value to default if there is one

Parameters:
[in] context referencing the current preference service
[in] key the key string
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete_tree AlpGlobalSettingsContext context,
const char *  key
 

deletes the all keys (subtree) below a given key as well as that key

Parameters:
[in] context referencing the current preference service
[in] key the key string
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_delete_tree_keeping_defaults AlpGlobalSettingsContext context,
const char *  key
 

deletes the all keys (subtree) below a given key as well as that key, except keeping default keys intact

Parameters:
[in] context referencing the current preference service
[in] key the key string
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

AlpGlobalSettingsEntry* alp_global_settings_entry_alloc void   ) 
 

allocate a new entry struct

Returns:
the pointer to a newly allocated entry object or NULL on failure

void alp_global_settings_entry_free AlpGlobalSettingsEntry e  ) 
 

decllocates a previously allocated entry object

Parameters:
[in] e the pointer to the entry object to be freed

alp_status_t alp_global_settings_entry_get_key_value const AlpGlobalSettingsEntry entry,
char *  key,
unsigned int  key_size,
AlpGlobalSettingsValue value
 

returns the key and the value of the key of an value entry

Parameters:
[in] entry the preference entry
[in] key the string buffer to receive the key string; can be NULL in that case the key is not returned
[in] key_size the size of the buffer key
[out] value the value of the key; can be NULL in that case the value is not returned
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ENTRY_INVALID if the iterator is invalid (not properly initialized with alp_global_settings_findkeys_start)

ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL if the supplied buffer is too small

alp_status_t alp_global_settings_entry_set_key_value AlpGlobalSettingsEntry entry,
const char *  key,
const AlpGlobalSettingsValue value
 

sets the key and the value of the key of an value entry; old resources are freed, if exist

Parameters:
[in] entry the preference entry
[in] key the key string to be set
[in] value the value of the key to be set
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ENTRY_INVALID if an entry cannot be successfully set (for example, if the key or the value parameters are invalid

alp_status_t alp_global_settings_findkeys_end AlpGlobalSettingsEntryIterator iterator  ) 
 

completes the traversal represented by the iterator; the associated resources are freed

Parameters:
[in] iterator the iterator which represents a directory traversal, must have been created by a previous call to alp_global_settings_findkeys_start()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if iterator is zero

ALP_STATUS_GLOBAL_SETTINGS_ITERATOR_INVALID if the iterator is invalid (not properly initialized with alp_global_settings_findkeys_start)

alp_status_t alp_global_settings_findkeys_get_key AlpGlobalSettingsEntryIterator iterator,
char *  key,
unsigned int  key_size
 

returns the key of the key pointed by an iterator separately

Parameters:
[in] iterator the iterator
[in] key the string buffer to receive the key string
[out] key_size the size of the buffer key
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if iterator is zero

ALP_STATUS_GLOBAL_SETTINGS_ITERATOR_INVALID if the iterator is invalid (not properly initialized with alp_global_settings_findkeys_start)

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_findkeys_next AlpGlobalSettingsEntryIterator iterator  ) 
 

advances the iterator to the next key in the list

Parameters:
[in,out] iterator the iterator which represents a directory traversal
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if iterator is zero

ALP_STATUS_GLOBAL_SETTINGS_ITERATOR_AT_END if the iterator is already at the end of the list

ALP_STATUS_GLOBAL_SETTINGS_ITERATOR_INVALID if the iterator is invalid (not properly initialized with alp_global_settings_findkeys_start)

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_findkeys_start AlpGlobalSettingsContext context,
const char *  dir_path,
AlpGlobalSettingsEntryIterator **  iterator
 

begin the traversal of the value of a key which is a list of subkeys

Parameters:
[in] context referencing the current preference service
[in] dir_path the key whose value is a list of keys (a directory) to be traversed
[out] iterator an "iterator" object created by this function for later traversal operations; to be freed when findkeys_end() is called
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if dir_path key not found

ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_DIR if the dir_path key is not a directory

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get AlpGlobalSettingsContext context,
const char *  key,
AlpGlobalSettingsValue value
 

get the current value of a key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] value the value for the key if the key exists
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_cwd AlpGlobalSettingsContext context,
char *  buf,
size_t  buf_size
 

get the current "directory" in the key space then following key paths which are not absolute are treated as relative to the "directory"

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[out] buf the buffer to contain the "current directory" on output
[in] buf_size the size of the buffer pointed to by the buffer parameter
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL if provided buffer is too small

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_default_mode AlpGlobalSettingsContext context,
mode_t *  mode
 

get the permission used when creating new keys

Parameters:
[in] context referencing the current preference service
[out] mode to hold the value of the mode
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_gid AlpGlobalSettingsContext context,
const char *  key,
gid_t *  id
 

get the group id of an existing key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] id to hold the group id of the key
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_key_blob_value AlpGlobalSettingsContext context,
const char *  key,
char *  value,
int  buffer_size,
int *  value_size
 

get a Blob key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[out] value the pointer to the buffer to receive the Blob value
[in] buffer_size the size of the buffer
[out] value_size the actual size of the Blob returned to the caller
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if a parameter value is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a Blob

ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_key_bool_value AlpGlobalSettingsContext context,
const char *  key,
gboolean *  value
 

get a boolean key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[out] value the value variable to receive the value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if a parameter value is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a bool

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_key_float_value AlpGlobalSettingsContext context,
const char *  key,
double *  value
 

get a float key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[out] value the value variable to receive the float value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if a parameter value is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a float

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_key_int_value AlpGlobalSettingsContext context,
const char *  key,
int *  value
 

get an integer key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[out] value the value variable to receive the value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if a parameter value is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not an integer

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_get_key_string_value AlpGlobalSettingsContext context,
const char *  key,
char *  value,
unsigned int  value_size
 

get a string key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[out] value the value object to receive the value
[in] value_size the size of the value buffer
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if a parameter value is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a string

ALP_STATUS_GLOBAL_SETTINGS_BUFFER_TOO_SMALL if value buffer is too short

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_mode AlpGlobalSettingsContext context,
const char *  key,
mode_t *  mode
 

get the permission on an existing key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] mode to hold the permission bits of the key
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_type AlpGlobalSettingsContext context,
const char *  key,
AlpGlobalSettingsValueType type
 

get the type of the value of a key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] type the type of the value for the key if the key exists
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_uid AlpGlobalSettingsContext context,
const char *  key,
uid_t *  id
 

get the current user id of a key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] id to hold the current uid
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_get_value_size AlpGlobalSettingsContext context,
const char *  key,
size_t *  size
 

get the type of the value of a key

Parameters:
[in] context referencing the current preference service
[in] key the key string
[out] size the size of the value for the key if the key exists
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_import_from_file AlpGlobalSettingsContext context,
const char *  file
 

to install a set of preferences from an XML file en masse

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] file the XML file name
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_init void   ) 
 

initialize the Global Settings system

Returns:
ALP_STATUS_OK on success

ALP_STATUS_ERROR on failure

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_list_keys AlpGlobalSettingsContext context,
const gchar *  pattern,
AlpGlobalSettingsEntryIterator **  iterator
 

get back a list of keys according to a glob pattern

Parameters:
[in] context referencing the current preference service
[in] pattern the glob pattern for the keys to be retrieved
[out] iterator an "iterator" object created by this function for later traversal operations; to be freed when findkeys_end() is called
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if no key fitting the pattern not found

ALP_STATUS_GLOBAL_SETTINGS_VALUE_NOT_DIR if the dir_path key is not a directory

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_open AlpGlobalSettingsContext **  context  ) 
 

obtain the preference service

Parameters:
[out] context on successful return, a reference to the preference service, which is created by the Global Setting API and will be freed upon alp_global_settings_close()
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_ERROR on failure

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set AlpGlobalSettingsContext context,
const char *  key,
const AlpGlobalSettingsValue value
 

set the value of a key; a new key is created if the key does not exist and the old value is overwritten if the key already exists

Parameters:
[in] context referencing the current preference service
[in] key the key string
[in] value the new value for the key to be set
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_STATUS_GLOBAL_SETTINGS_ERROR on failure

alp_status_t alp_global_settings_set_cwd AlpGlobalSettingsContext context,
const char *  cwd
 

set the current "directory" in the key space then following key paths which are not absolute will be treated as relative to the "directory"

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] cwd the new "current directory"
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_default_mode AlpGlobalSettingsContext context,
mode_t  mode
 

set the permission used when creating new keys

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] mode the new access permission
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_gid AlpGlobalSettingsContext context,
const char *  key,
gid_t  id
 

set the group id of an existing key

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key whose gid is to be set
[in] id the new gid
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_blob_value AlpGlobalSettingsContext context,
const char *  key,
const char *  value,
int  value_size
 

set a float

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[in] value the address of the Blob
[in] value_size the size of the Blob
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_bool_value AlpGlobalSettingsContext context,
const char *  key,
gboolean  value
 

set a boolean key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[in] value the boolean value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_directory AlpGlobalSettingsContext context,
const char *  key
 

create a directory: this call fails if a key with the same name already exists

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_KEY_EXISTS if key exists already

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_float_value AlpGlobalSettingsContext context,
const char *  key,
double  value
 

set a float

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[in] value the float value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_int_value AlpGlobalSettingsContext context,
const char *  key,
int  value
 

set an integer key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[in] value the integer value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

alp_status_t alp_global_settings_set_key_string_value AlpGlobalSettingsContext context,
const char *  key,
const char *  value
 

set a string key-value pair

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key string
[in] value the string value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ERROR if failure

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_mode AlpGlobalSettingsContext context,
const char *  key,
mode_t  mode
 

set the permission on an existing key

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key whose access permission is to be set
[in] mode the new access permission
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_notification_on_off AlpGlobalSettingsContext context,
int  on_off
 

set the key change notification to be on or off

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] on_off turn the notification on (non-zero) or off (0)
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

ALP_GLOBAL_SETTINGS_RPC alp_status_t alp_global_settings_set_uid AlpGlobalSettingsContext context,
const char *  key,
uid_t  id
 

set the user id on an existing key

Parameters:
[in] context a reference to the preference service returned previously by alp_global_settings_open()
[in] key the key whose id is to be set
[in] id the new user id
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_ARGUMENT_INVALID if context is zero

ALP_STATUS_GLOBAL_SETTINGS_KEY_NOT_FOUND if key does not exist

ALP_STATUS_GLOBAL_SETTINGS_PERMISSION_DENIED if no permission for operation

AlpGlobalSettingsValue* alp_global_settings_value_alloc void   ) 
 

allocate a new value struct

Returns:
the pointer to a newly allocated value object or NULL on failure

void alp_global_settings_value_clean AlpGlobalSettingsValue e  ) 
 

decllocates resources used by a value object but not the value object itself

Parameters:
[in] e the pointer to the value object to be cleaned

void alp_global_settings_value_free AlpGlobalSettingsValue e  ) 
 

decllocates a previously allocated value object

Parameters:
[in] e the pointer to the value object to be freed

alp_status_t alp_global_settings_value_get_bool AlpGlobalSettingsValue value,
gboolean *  b
 

get the boolean preference value contained in an value object

Parameters:
[in] value the value object
[out] b the integer to receive the integral value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not an boolean

ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID if this value object contains no valid value data

alp_status_t alp_global_settings_value_get_float AlpGlobalSettingsValue value,
double *  f
 

get the float preference value contained in an value object

Parameters:
[in] value the value object
[out] f the float to receive the integral value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a float

ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID if this value object contains no valid value data

alp_status_t alp_global_settings_value_get_int AlpGlobalSettingsValue value,
int *  i
 

get the integer preference value contained in an value object

Parameters:
[in] value the value object
[out] i the integer to receive the integral value
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not an integer

ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID if this value object contains no valid value data

alp_status_t alp_global_settings_value_get_list AlpGlobalSettingsValue value,
GList **  list
 

get the dir (list) preference value contained in an value object

Parameters:
[in] value the value object
[out] list the list object to receive the list data (a list of AlpGlobalSettingsEntry_t). A copy of the current list will be allocated and created. This list needs to be freed by the caller
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a dir/list

ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID if this value object contains no valid value data

alp_status_t alp_global_settings_value_get_string AlpGlobalSettingsValue value,
char *  string,
unsigned int  string_size
 

get the string preference value contained in an value object

Parameters:
[in] value the value object
[out] string the string buffer to receive the string value
[in] string_size the size of the string buffer
Returns:
ALP_STATUS_OK on success

ALP_STATUS_GLOBAL_SETTINGS_INCORRECT_TYPE if the value is not a string

ALP_STATUS_GLOBAL_SETTINGS_VALUE_INVALID if this value object contains no valid value data

void alp_global_settings_value_list_free GList *  l  ) 
 

decllocates a list of value obbjects; the list is used to represent a list value

Parameters:
[in] l the pointer to the list of value objects to be freed

alp_status_t alp_global_settings_value_set_bool AlpGlobalSettingsValue value,
gboolean  b
 

create a bool preference value; the old value, if any, is freed

Parameters:
[in,out] value the value to be set
[in] b the boolean to be set
Returns:
ALP_STATUS_OK on success

alp_status_t alp_global_settings_value_set_float AlpGlobalSettingsValue value,
double  f
 

create a float preference value; the old value, if any, is freed

Parameters:
[in,out] value the value to be set
[in] f the float to be set
Returns:
ALP_STATUS_OK on success

alp_status_t alp_global_settings_value_set_int AlpGlobalSettingsValue value,
int  i
 

create an integer preference value; the old value, if any, is freed

Parameters:
[in,out] value the value to be set
[in] i to integer to be set
Returns:
ALP_STATUS_OK on success

alp_status_t alp_global_settings_value_set_list AlpGlobalSettingsValue value,
const GList *  list
 

set a list (dir) preference value; the old value, if any, is freed

Parameters:
[in,out] value the value to be set
[in] list the directory or list of to be set; the list should contain AlpGlobalSettingsEntry_t's
Returns:
ALP_STATUS_OK on success

alp_status_t alp_global_settings_value_set_string AlpGlobalSettingsValue value,
const char *  string
 

set a string preference value; the old value, if any, is freed

Parameters:
[in,out] value the value to be set
[in] string the string to be set
Returns:
ALP_STATUS_OK on success


Generated on Sat Dec 16 20:29:50 2006 for hiker-0.9 by  doxygen 1.4.4