User Config

Collaboration diagram for User Config:

Data Structures
struct	UCSysConfig
struct	UCAsyncParams

Typedefs
typedef int32_t	UCError
typedef int32_t	UCHandle
typedef struct UCSysConfig	UCSysConfig
typedef struct UCAsyncParams	UCAsyncParams
typedef enum UCCommand	UCCommand
typedef enum UCDataType	UCDataType
typedef enum UCErrors	UCErrors
typedef enum UCFileSys	UCFileSys
typedef void(*	UCAsyncCallbackFn) (UCError result, UCCommand command, uint32_t count, UCSysConfig *settings, void *context)

Enumerations
enum	UCCommand {   UC_CMD_READ_SYS_CONFIG = 0x30 ,   UC_CMD_WRITE_SYS_CONFIG = 0x31 ,   UC_CMD_DELETE_SYS_CONFIG = 0x32 ,   UC_CMD_QUERY_SYS_CONFIG = 0x33 ,   UC_CMD_LIST_SYS_CONFIG = 0x34 }
enum	UCDataType {   UC_DATATYPE_UNDEFINED = 0x00 ,   UC_DATATYPE_UNSIGNED_BYTE = 0x01 ,   UC_DATATYPE_UNSIGNED_SHORT = 0x02 ,   UC_DATATYPE_UNSIGNED_INT = 0x03 ,   UC_DATATYPE_SIGNED_INT = 0x04 ,   UC_DATATYPE_FLOAT = 0x05 ,   UC_DATATYPE_STRING = 0x06 ,   UC_DATATYPE_HEXBINARY = 0x07 ,   UC_DATATYPE_COMPLEX = 0x08 ,   UC_DATATYPE_INVALID = 0xFF }
enum	UCErrors {   UC_ERROR_OK = 0 ,   UC_ERROR_ERROR = -1 ,   UC_ERROR_OTHER = -0x200001 ,   UC_ERROR_SYSTEM = -0x200002 ,   UC_ERROR_ALLOC = -0x200003 ,   UC_ERROR_OPCODE = -0x200004 ,   UC_ERROR_INVALID_PARAM = -0x200005 ,   UC_ERROR_INVALID_TYPE = -0x200006 ,   UC_ERROR_UNSUPPORTED = -0x200007 ,   UC_ERROR_NON_LEAF_NODE = -0x200008 ,   UC_ERROR_KEY_NOT_FOUND = -0x200009 ,   UC_ERROR_MODIFY = -0x20000A ,   UC_ERROR_STRING_TOO_LONG = -0x20000B ,   UC_ERROR_ROOT_KEYS_DIFFER = -0x20000C ,   UC_ERROR_INVALID_LOCATION = -0x20000D ,   UC_ERROR_BAD_COMMENT = -0x20000E ,   UC_ERROR_READ_ACCESS = -0x20000F ,   UC_ERROR_WRITE_ACCESS = -0x200010 ,   UC_ERROR_CREATE_ACCESS = -0x200011 ,   UC_ERROR_FILE_SYS_NAME = -0x200012 ,   UC_ERROR_FILE_SYS_INIT = -0x200013 ,   UC_ERROR_FILE_SYS_MOUNT = -0x200014 ,   UC_ERROR_FILE_OPEN = -0x200015 ,   UC_ERROR_FILE_STAT = -0x200016 ,   UC_ERROR_FILE_READ = -0x200017 ,   UC_ERROR_FILE_WRITE = -0x200018 ,   UC_ERROR_FILE_TOO_BIG = -0x200019 ,   UC_ERROR_FILE_REMOVE = -0x20001A ,   UC_ERROR_FILE_RENAME = -0x20001B ,   UC_ERROR_FILE_CLOSE = -0x20001C ,   UC_ERROR_FILE_SEEK = -0x20001D ,   UC_ERROR_FILE_CONFIRM = -0x20001E ,   UC_ERROR_FILE_BACKUP = -0x20001F ,   UC_ERROR_MALFORMED_XML = -0x200020 ,   UC_ERROR_VERSION = -0x200021 ,   UC_ERROR_NO_IPC_BUFFERS = -0x200022 ,   UC_ERROR_FILE_LOCK_NEEDED = -0x200024 ,   UC_ERROR_SYS_PROT = -0x200028 }
enum	UCFileSys {   UC_FILE_SYS_INVALID = 0x00 ,   UC_FILE_SYS_SYS = 0x01 ,   UC_FILE_SYS_SLC = 0x02 ,   UC_FILE_SYS_RAM = 0x03 }

Functions
UCHandle	UCOpen ()
UCError	UCClose (UCHandle handle)
UCError	UCDeleteSysConfig (UCHandle handle, uint32_t count, UCSysConfig *settings)
UCError	UCDeleteSysConfigAsync (UCHandle handle, uint32_t count, UCSysConfig *settings, UCAsyncParams *asyncParams)
UCError	UCReadSysConfig (UCHandle handle, uint32_t count, UCSysConfig *settings)
UCError	UCReadSysConfigAsync (UCHandle handle, uint32_t count, UCSysConfig *settings, UCAsyncParams *asyncParams)
UCError	UCWriteSysConfig (UCHandle handle, uint32_t count, UCSysConfig *settings)
UCError	UCWriteSysConfigAsync (UCHandle handle, uint32_t count, UCSysConfig *settings, UCAsyncParams *asyncParams)

Detailed Description

---

Data Structure Documentation

UCSysConfig

struct UCSysConfig

Definition at line 95 of file userconfig.h.

Data Fields
char	name[64]
uint32_t	access
UCDataType	dataType
UCError	error
uint32_t	dataSize
void *	data

UCAsyncParams

struct UCAsyncParams

Definition at line 119 of file userconfig.h.

Data Fields
UCAsyncCallbackFn	callback
void *	context
UCCommand	command
uint32_t	unk0x0C
uint32_t	count
UCSysConfig *	settings
IOSVec *	vecs

Typedef Documentation

UCError

typedef int32_t UCError

Definition at line 16 of file userconfig.h.

UCHandle

typedef int32_t UCHandle

Definition at line 17 of file userconfig.h.

UCSysConfig

typedef struct UCSysConfig UCSysConfig

Definition at line 17 of file userconfig.h.

UCAsyncParams

typedef struct UCAsyncParams UCAsyncParams

Definition at line 17 of file userconfig.h.

UCCommand

typedef enum UCCommand UCCommand

UCDataType

typedef enum UCDataType UCDataType

UCErrors

typedef enum UCErrors UCErrors

UCFileSys

typedef enum UCFileSys UCFileSys

UCAsyncCallbackFn

typedef void(* UCAsyncCallbackFn) (UCError result, UCCommand command, uint32_t count, UCSysConfig *settings, void *context)

Definition at line 113 of file userconfig.h.

Enumeration Type Documentation

UCCommand

enum UCCommand

Enumerator
UC_CMD_READ_SYS_CONFIG
UC_CMD_WRITE_SYS_CONFIG
UC_CMD_DELETE_SYS_CONFIG
UC_CMD_QUERY_SYS_CONFIG
UC_CMD_LIST_SYS_CONFIG

Definition at line 21 of file userconfig.h.

UCDataType

enum UCDataType

Enumerator
UC_DATATYPE_UNDEFINED
UC_DATATYPE_UNSIGNED_BYTE
UC_DATATYPE_UNSIGNED_SHORT
UC_DATATYPE_UNSIGNED_INT
UC_DATATYPE_SIGNED_INT
UC_DATATYPE_FLOAT
UC_DATATYPE_STRING
UC_DATATYPE_HEXBINARY
UC_DATATYPE_COMPLEX
UC_DATATYPE_INVALID

Definition at line 30 of file userconfig.h.

UCErrors

enum UCErrors

Enumerator
UC_ERROR_OK
UC_ERROR_ERROR
UC_ERROR_OTHER
UC_ERROR_SYSTEM
UC_ERROR_ALLOC
UC_ERROR_OPCODE
UC_ERROR_INVALID_PARAM
UC_ERROR_INVALID_TYPE
UC_ERROR_UNSUPPORTED
UC_ERROR_NON_LEAF_NODE
UC_ERROR_KEY_NOT_FOUND
UC_ERROR_MODIFY
UC_ERROR_STRING_TOO_LONG
UC_ERROR_ROOT_KEYS_DIFFER
UC_ERROR_INVALID_LOCATION
UC_ERROR_BAD_COMMENT
UC_ERROR_READ_ACCESS
UC_ERROR_WRITE_ACCESS
UC_ERROR_CREATE_ACCESS
UC_ERROR_FILE_SYS_NAME
UC_ERROR_FILE_SYS_INIT
UC_ERROR_FILE_SYS_MOUNT
UC_ERROR_FILE_OPEN
UC_ERROR_FILE_STAT
UC_ERROR_FILE_READ
UC_ERROR_FILE_WRITE
UC_ERROR_FILE_TOO_BIG
UC_ERROR_FILE_REMOVE
UC_ERROR_FILE_RENAME
UC_ERROR_FILE_CLOSE
UC_ERROR_FILE_SEEK
UC_ERROR_FILE_CONFIRM
UC_ERROR_FILE_BACKUP
UC_ERROR_MALFORMED_XML
UC_ERROR_VERSION
UC_ERROR_NO_IPC_BUFFERS
UC_ERROR_FILE_LOCK_NEEDED
UC_ERROR_SYS_PROT

Definition at line 44 of file userconfig.h.

UCFileSys

enum UCFileSys

Enumerator
UC_FILE_SYS_INVALID
UC_FILE_SYS_SYS
UC_FILE_SYS_SLC
UC_FILE_SYS_RAM

Definition at line 86 of file userconfig.h.

Function Documentation

UCOpen()

UCHandle UCOpen

(

)

UCClose()

UCError UCClose

(

UCHandle

handle

)

UCDeleteSysConfig()

UCError UCDeleteSysConfig	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings
	)

UCDeleteSysConfigAsync()

UCError UCDeleteSysConfigAsync	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings,
		UCAsyncParams *	asyncParams
	)

UCReadSysConfig()

UCError UCReadSysConfig	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings
	)

UCReadSysConfigAsync()

UCError UCReadSysConfigAsync	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings,
		UCAsyncParams *	asyncParams
	)

UCWriteSysConfig()

UCError UCWriteSysConfig	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings
	)

UCWriteSysConfigAsync()

UCError UCWriteSysConfigAsync	(	UCHandle	handle,
		uint32_t	count,
		UCSysConfig *	settings,
		UCAsyncParams *	asyncParams
	)