OrxConfig

Macros
#define	orxCONFIG_KZ_RESOURCE_GROUP   "Config"

Typedefs
typedef orxSTATUS(orxFASTCALL *	orxCONFIG_BOOTSTRAP_FUNCTION) ()
typedef orxBOOL(orxFASTCALL *	orxCONFIG_CLEAR_FUNCTION) (const orxSTRING _zSectionName, const orxSTRING _zKeyName)
typedef orxBOOL(orxFASTCALL *	orxCONFIG_SAVE_FUNCTION) (const orxSTRING _zSectionName, const orxSTRING _zKeyName, const orxSTRING _zFileName, orxBOOL _bUseEncryption)

Enumerations
enum	orxCONFIG_EVENT { orxCONFIG_EVENT_RELOAD_START = 0, orxCONFIG_EVENT_RELOAD_STOP, orxCONFIG_EVENT_NUMBER, orxCONFIG_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_AppendListString (const orxSTRING _zKey, const orxSTRING _azValue[], orxU32 _u32Number)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_Clear (const orxCONFIG_CLEAR_FUNCTION _pfnClearCallback)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_ClearSection (const orxSTRING _zSectionName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_ClearValue (const orxSTRING _zKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_CopyFile (const orxSTRING _zDstFileName, const orxSTRING _zSrcFileName, const orxSTRING _zEncryptionKey)
orxDLLAPI orxSTRING orxFASTCALL	orxConfig_DuplicateRawValue (const orxSTRING _zKey)
orxDLLAPI void orxFASTCALL	orxConfig_Exit ()
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_GetBool (const orxSTRING _zKey)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetCurrentSection ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetEncryptionKey ()
orxDLLAPI orxFLOAT orxFASTCALL	orxConfig_GetFloat (const orxSTRING _zKey)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetKey (orxU32 _u32KeyIndex)
orxDLLAPI orxU32 orxFASTCALL	orxConfig_GetKeyCount ()
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_GetListBool (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxS32 orxFASTCALL	orxConfig_GetListCount (const orxSTRING _zKey)
orxDLLAPI orxFLOAT orxFASTCALL	orxConfig_GetListFloat (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxS32 orxFASTCALL	orxConfig_GetListS32 (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxS64 orxFASTCALL	orxConfig_GetListS64 (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetListString (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxU32 orxFASTCALL	orxConfig_GetListU32 (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxU64 orxFASTCALL	orxConfig_GetListU64 (const orxSTRING _zKey, orxS32 _s32ListIndex)
orxDLLAPI orxVECTOR *orxFASTCALL	orxConfig_GetListVector (const orxSTRING _zKey, orxS32 _s32ListIndex, orxVECTOR *_pvVector)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetMainFileName ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetOrigin (const orxSTRING _zSectionName)
orxDLLAPI orxSTRINGID orxFASTCALL	orxConfig_GetOriginID (const orxSTRING _zSectionName)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetParent (const orxSTRING _zSectionName)
orxDLLAPI orxS32 orxFASTCALL	orxConfig_GetS32 (const orxSTRING _zKey)
orxDLLAPI orxS64 orxFASTCALL	orxConfig_GetS64 (const orxSTRING _zKey)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetSection (orxU32 _u32SectionIndex)
orxDLLAPI orxU32 orxFASTCALL	orxConfig_GetSectionCount ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetString (const orxSTRING _zKey)
orxDLLAPI orxU32 orxFASTCALL	orxConfig_GetU32 (const orxSTRING _zKey)
orxDLLAPI orxU64 orxFASTCALL	orxConfig_GetU64 (const orxSTRING _zKey)
orxDLLAPI const orxSTRING orxFASTCALL	orxConfig_GetValueSource (const orxSTRING _zKey)
orxDLLAPI orxVECTOR *orxFASTCALL	orxConfig_GetVector (const orxSTRING _zKey, orxVECTOR *_pvVector)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_HasSection (const orxSTRING _zSectionName)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_HasValue (const orxSTRING _zKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsCommandValue (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsDynamicValue (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsInheritedValue (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsList (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsLocallyInheritedValue (const orxSTRING _zKey)
orxDLLAPI orxBOOL orxFASTCALL	orxConfig_IsRandomValue (const orxSTRING _zKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_Load (const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_LoadFromMemory (orxCHAR *_acBuffer, orxU32 _u32BufferSize)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_MergeFiles (const orxSTRING _zDstFileName, const orxSTRING *_azSrcFileName, orxU32 _u32Number, const orxSTRING _zEncryptionKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_PopSection ()
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_ProtectSection (const orxSTRING _zSectionName, orxBOOL _bProtect)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_PushSection (const orxSTRING _zSectionName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_ReloadHistory ()
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_RenameSection (const orxSTRING _zSectionName, const orxSTRING _zNewSectionName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_Save (const orxSTRING _zFileName, orxBOOL _bUseEncryption, const orxCONFIG_SAVE_FUNCTION _pfnSaveCallback)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SelectSection (const orxSTRING _zSectionName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetBaseName (const orxSTRING _zBaseName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetBool (const orxSTRING _zKey, orxBOOL _bValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetBootstrap (const orxCONFIG_BOOTSTRAP_FUNCTION _pfnBootstrap)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetDefaultParent (const orxSTRING _zSectionName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetEncryptionKey (const orxSTRING _zEncryptionKey)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetFloat (const orxSTRING _zKey, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetListString (const orxSTRING _zKey, const orxSTRING _azValue[], orxU32 _u32Number)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetParent (const orxSTRING _zSectionName, const orxSTRING _zParentName)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetS32 (const orxSTRING _zKey, orxS32 _s32Value)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetS64 (const orxSTRING _zKey, orxS64 _s64Value)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetString (const orxSTRING _zKey, const orxSTRING _zValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetStringBlock (const orxSTRING _zKey, const orxSTRING _zValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetU32 (const orxSTRING _zKey, orxU32 _u32Value)
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetU64 (const orxSTRING _zKey, orxU64 _u64Value)
orxDLLAPI void orxFASTCALL	orxConfig_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxConfig_SetVector (const orxSTRING _zKey, const orxVECTOR *_pvValue)

Detailed Description

Config module Module that handles configuration files

Macro Definition Documentation

#define orxCONFIG_KZ_RESOURCE_GROUP   "Config"

DefinesConfig resource group

Definition at line 54 of file orxConfig.h.

Typedef Documentation

typedef orxSTATUS(orxFASTCALL * orxCONFIG_BOOTSTRAP_FUNCTION) ()

Definition at line 77 of file orxConfig.h.

typedef orxBOOL(orxFASTCALL * orxCONFIG_CLEAR_FUNCTION) (const orxSTRING _zSectionName, const orxSTRING _zKeyName)

Config callback function type to use with clear function

Definition at line 75 of file orxConfig.h.

typedef orxBOOL(orxFASTCALL * orxCONFIG_SAVE_FUNCTION) (const orxSTRING _zSectionName, const orxSTRING _zKeyName, const orxSTRING _zFileName, orxBOOL _bUseEncryption)

Config callback function type to use with save function

Definition at line 72 of file orxConfig.h.

Enumeration Type Documentation

enum orxCONFIG_EVENT

Event enum

Enumerator
orxCONFIG_EVENT_RELOAD_START	Event sent when reloading config starts
orxCONFIG_EVENT_RELOAD_STOP	Event sent when reloading config stops
orxCONFIG_EVENT_NUMBER
orxCONFIG_EVENT_NONE

Definition at line 59 of file orxConfig.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_AppendListString	(	const orxSTRING	_zKey,
		const orxSTRING	_azValue[],
		orxU32	_u32Number
	)

Appends string values to a config list (will create a new entry if not already present)

Parameters

[in]	_zKey	Key name
[in]	_azValue	Values
[in]	_u32Number	Number of values

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_Clear

(

const orxCONFIG_CLEAR_FUNCTION

_pfnClearCallback

)

Clears all config info

Parameters

[in]

_pfnClearCallback

Callback used to filter sections/keys to clear. If null, all sections/keys will be cleared

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_ClearSection

(

const orxSTRING

_zSectionName

)

Clears section

Parameters

[in]

_zSectionName

Section name to clear

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_ClearValue

(

const orxSTRING

_zKey

)

Clears a value from current selected section

Parameters

[in]

_zKey

Key name

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_CopyFile	(	const orxSTRING	_zDstFileName,
		const orxSTRING	_zSrcFileName,
		const orxSTRING	_zEncryptionKey
	)

Copies a file with optional encryption

Parameters

[in]	_zDstFileName	Name of the destination file
[in]	_zSrcFileName	Name of the source file
[in]	_zEncryptionKey	Encryption key to use when writing destination file, orxNULL for no encryption

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTRING orxFASTCALL orxConfig_DuplicateRawValue

(

const orxSTRING

_zKey

)

Duplicates a raw value (string) from config

Parameters

[in]

_zKey

Key name

Returns

The value. If non-null, needs to be deleted by the caller with orxString_Delete()

orxDLLAPI void orxFASTCALL orxConfig_Exit

(

)

Exits from the Config Module

orxDLLAPI orxBOOL orxFASTCALL orxConfig_GetBool

(

const orxSTRING

_zKey

)

Reads a boolean value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetCurrentSection

(

)

Gets current working section

Returns

Current selected section

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetEncryptionKey

(

)

Gets encryption key

Returns

Current encryption key / orxSTRING_EMPTY

orxDLLAPI orxFLOAT orxFASTCALL orxConfig_GetFloat

(

const orxSTRING

_zKey

)

Reads a float value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetKey

(

orxU32

_u32KeyIndex

)

Gets key for the current section at the given index

Parameters

[in]

_u32KeyIndex

Index of the desired key

Returns

orxSTRING if exist, orxSTRING_EMPTY otherwise

orxDLLAPI orxU32 orxFASTCALL orxConfig_GetKeyCount

(

)

Gets key count of the current section

Returns

Key count of the current section if valid, 0 otherwise

orxDLLAPI orxBOOL orxFASTCALL orxConfig_GetListBool	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads a boolean value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxS32 orxFASTCALL orxConfig_GetListCount

(

const orxSTRING

_zKey

)

Gets list count for a given key

Parameters

[in]

_zKey

Key name

Returns

List count if it's a valid list, 0 otherwise

orxDLLAPI orxFLOAT orxFASTCALL orxConfig_GetListFloat	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads a float value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxS32 orxFASTCALL orxConfig_GetListS32	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads a signed integer value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxS64 orxFASTCALL orxConfig_GetListS64	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads a signed integer value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetListString	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads a string value from config list Beware: result might not persist through any subsequent orxConfig_Get* calls

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxU32 orxFASTCALL orxConfig_GetListU32	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads an unsigned integer value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxU64 orxFASTCALL orxConfig_GetListU64	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex
	)

Reads an unsigned integer value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random

Returns

The value

orxDLLAPI orxVECTOR* orxFASTCALL orxConfig_GetListVector	(	const orxSTRING	_zKey,
		orxS32	_s32ListIndex,
		orxVECTOR *	_pvVector
	)

Reads a vector value from config list

Parameters

[in]	_zKey	Key name
[in]	_s32ListIndex	Index of desired item in list / -1 for random
[out]	_pvVector	Storage for vector value

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetMainFileName

(

)

Gets config main file name

Returns

Config main file name / orxSTRING_EMPTY

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetOrigin

(

const orxSTRING

_zSectionName

)

Gets section origin (ie. the file where it was defined for the first time or orxSTRING_EMPTY if not defined via a file)

Parameters

[in]

_zSectionName

Concerned section name

Returns

orxSTRING if found, orxSTRING_EMPTY otherwise

orxDLLAPI orxSTRINGID orxFASTCALL orxConfig_GetOriginID

(

const orxSTRING

_zSectionName

)

Gets section origin ID (ie. the file where it was defined for the first time or orxSTRING_EMPTY if not defined via a file)

Parameters

[in]

_zSectionName

Concerned section name

Returns

String ID if found, orxSTRINGID_UNDEFINED otherwise

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetParent

(

const orxSTRING

_zSectionName

)

Gets a section's parent

Parameters

[in]

_zSectionName

Concerned section

Returns

Section's parent name if set or orxSTRING_EMPTY if no parent has been forced, orxNULL otherwise

orxDLLAPI orxS32 orxFASTCALL orxConfig_GetS32

(

const orxSTRING

_zKey

)

Reads a signed integer value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI orxS64 orxFASTCALL orxConfig_GetS64

(

const orxSTRING

_zKey

)

Reads a signed integer value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetSection

(

orxU32

_u32SectionIndex

)

Gets section at the given index

Parameters

[in]

_u32SectionIndex

Index of the desired section

Returns

orxSTRING if exist, orxSTRING_EMPTY otherwise

orxDLLAPI orxU32 orxFASTCALL orxConfig_GetSectionCount

(

)

Gets section count

Returns

Section count

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetString

(

const orxSTRING

_zKey

)

Reads a string value from config (will take a random value if a list is provided for this key) Beware: result might not persist through any subsequent orxConfig_Get* calls

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI orxU32 orxFASTCALL orxConfig_GetU32

(

const orxSTRING

_zKey

)

Reads an unsigned integer value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI orxU64 orxFASTCALL orxConfig_GetU64

(

const orxSTRING

_zKey

)

Reads an unsigned integer value from config (will take a random value if a list is provided for this key)

Parameters

[in]

_zKey

Key name

Returns

The value

orxDLLAPI const orxSTRING orxFASTCALL orxConfig_GetValueSource

(

const orxSTRING

_zKey

)

Gets a value's source section (ie. the section where the value is explicitly defined), only considering section inheritance, not local one

Parameters

[in]

_zKey

Key name

Returns

Name of the section that explicitly contains the value, orxSTRING_EMPTY if not found

orxDLLAPI orxVECTOR* orxFASTCALL orxConfig_GetVector	(	const orxSTRING	_zKey,
		orxVECTOR *	_pvVector
	)

Reads a vector value from config (will take a random value if a list is provided for this key)

Parameters

[in]	_zKey	Key name
[out]	_pvVector	Storage for vector value

Returns

The value if valid, orxNULL otherwise

orxDLLAPI orxBOOL orxFASTCALL orxConfig_HasSection

(

const orxSTRING

_zSectionName

)

Has section for the given section name?

Parameters

[in]

_zSectionName

Section name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_HasValue

(

const orxSTRING

_zKey

)

Has specified value for the given key?

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_Init

(

)

Initializes the Config Module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsCommandValue

(

const orxSTRING

_zKey

)

Is this a command value? (ie. lazily evaluated command: %...)

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsDynamicValue

(

const orxSTRING

_zKey

)

Is this value dynamic? (ie. random and/or a list or command)

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsInheritedValue

(

const orxSTRING

_zKey

)

Is this value inherited from another one (either locally or at section level)?

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsList

(

const orxSTRING

_zKey

)

Is value a list for the given key?

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsLocallyInheritedValue

(

const orxSTRING

_zKey

)

Is this value locally inherited from another one (ie. with a Value = ... syntax)?

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxConfig_IsRandomValue

(

const orxSTRING

_zKey

)

Is this value random? (ie. using '~' character, within or without a list)

Parameters

[in]

_zKey

Key name

Returns

orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_Load

(

const orxSTRING

_zFileName

)

Loads config file from source

Parameters

[in]

_zFileName

File name

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_LoadFromMemory	(	orxCHAR *	_acBuffer,
		orxU32	_u32BufferSize
	)

Loads config data from a memory buffer. NB: the buffer will be modified during processing!

Parameters

[in]	_acBuffer	Buffer to process, will be modified during processing
[in]	_u32BufferSize	Size of the buffer

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_MergeFiles	(	const orxSTRING	_zDstFileName,
		const orxSTRING *	_azSrcFileName,
		orxU32	_u32Number,
		const orxSTRING	_zEncryptionKey
	)

Merges multiple files into a single one, with optional encryption

Parameters

[in]	_zDstFileName	Name of the destination file
[in]	_azSrcFileName	List of the names of the source files
[in]	_u32Number	Number of source file names
[in]	_zEncryptionKey	Encryption key to use when writing destination file, orxNULL for no encryption

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_PopSection

(

)

Pops last section from section stack

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_ProtectSection	(	const orxSTRING	_zSectionName,
		orxBOOL	_bProtect
	)

Protects/unprotects a section from deletion (content might still be changed or deleted, but the section itself will resist delete/clear calls)

Parameters

[in]	_zSectionName	Section name to protect
[in]	_bProtect	orxTRUE for protecting the section, orxFALSE to remove the protection

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_PushSection

(

const orxSTRING

_zSectionName

)

Pushes a section (storing the current one on section stack)

Parameters

[in]

_zSectionName

Section name to push

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_ReloadHistory

(

)

Reloads config files from history

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_RenameSection	(	const orxSTRING	_zSectionName,
		const orxSTRING	_zNewSectionName
	)

Renames a section

Parameters

[in]	_zSectionName	Section to rename
[in]	_zNewSectionName	New name for the section

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_Save	(	const orxSTRING	_zFileName,
		orxBOOL	_bUseEncryption,
		const orxCONFIG_SAVE_FUNCTION	_pfnSaveCallback
	)

Writes config to given file. Will overwrite any existing file, including all comments.

Parameters

[in]	_zFileName	File name, if null or empty the default file name will be used
[in]	_bUseEncryption	Use file encryption to make it human non-readable?
[in]	_pfnSaveCallback	Callback used to filter sections/keys to save. If null, all sections/keys will be saved

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SelectSection

(

const orxSTRING

_zSectionName

)

Selects current working section

Parameters

[in]

_zSectionName

Section name to select

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetBaseName

(

const orxSTRING

_zBaseName

)

Sets config base name

Parameters

[in]

_zBaseName

Base name used for default config file

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetBool	(	const orxSTRING	_zKey,
		orxBOOL	_bValue
	)

Writes a boolean value to config

Parameters

[in]	_zKey	Key name
[in]	_bValue	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetBootstrap

(

const orxCONFIG_BOOTSTRAP_FUNCTION

_pfnBootstrap

)

Sets config bootstrap function: this function will get called when the config module is initialized, before any config file is loaded. The only available APIs from within the bootstrap function are those of orxConfig and its dependencies (orxMemory, orxString, orxFile, orxEvent, orxResource, ...)

Parameters

[in]

_pfnBootstrap

Bootstrap function that will get called at module init, before loading any config file. If this function returns orxSTATUS_FAILURE, the default config file will be skipped, otherwise the regular load sequence will take place

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetDefaultParent

(

const orxSTRING

_zSectionName

)

Sets default parent for all sections

Parameters

[in]

_zSectionName

Section name that will be used as an implicit default parent section for all config sections, if orxNULL is provided, default parent will be removed

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetEncryptionKey

(

const orxSTRING

_zEncryptionKey

)

Sets encryption key

Parameters

[in]

_zEncryptionKey

Encryption key to use, orxNULL to clear

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetFloat	(	const orxSTRING	_zKey,
		orxFLOAT	_fValue
	)

Writes a float value to config

Parameters

[in]	_zKey	Key name
[in]	_fValue	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetListString	(	const orxSTRING	_zKey,
		const orxSTRING	_azValue[],
		orxU32	_u32Number
	)

Writes a list of string values to config

Parameters

[in]	_zKey	Key name
[in]	_azValue	Values
[in]	_u32Number	Number of values

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetParent	(	const orxSTRING	_zSectionName,
		const orxSTRING	_zParentName
	)

Sets a section's parent

Parameters

[in]	_zSectionName	Concerned section, if the section doesn't exist, it will be created
[in]	_zParentName	Parent section's name, if the section doesn't exist, it will be created, if orxNULL is provided, the former parent will be erased, if orxSTRING_EMPTY is provided, "no default parent" will be enforced

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetS32	(	const orxSTRING	_zKey,
		orxS32	_s32Value
	)

Writes a signed integer value to config

Parameters

[in]	_zKey	Key name
[in]	_s32Value	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetS64	(	const orxSTRING	_zKey,
		orxS64	_s64Value
	)

Writes a signed integer value to config

Parameters

[in]	_zKey	Key name
[in]	_s64Value	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetString	(	const orxSTRING	_zKey,
		const orxSTRING	_zValue
	)

Writes a string value to config

Parameters

[in]	_zKey	Key name
[in]	_zValue	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetStringBlock	(	const orxSTRING	_zKey,
		const orxSTRING	_zValue
	)

Writes a string value to config, in block mode

Parameters

[in]	_zKey	Key name
[in]	_zValue	Value to write in block mode

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetU32	(	const orxSTRING	_zKey,
		orxU32	_u32Value
	)

Writes an unsigned integer value to config

Parameters

[in]	_zKey	Key name
[in]	_u32Value	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetU64	(	const orxSTRING	_zKey,
		orxU64	_u64Value
	)

Writes an unsigned integer value to config

Parameters

[in]	_zKey	Key name
[in]	_u64Value	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxConfig_Setup

(

)

Config module setup

orxDLLAPI orxSTATUS orxFASTCALL orxConfig_SetVector	(	const orxSTRING	_zKey,
		const orxVECTOR *	_pvValue
	)

Writes a vector value to config

Parameters

[in]	_zKey	Key name
[in]	_pvValue	Value

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE