Config

Functions
int	OGE_OpenCustomConfig (string sConfigFile)
	Open custom configuration file (ini file)
int	OGE_CloseCustomConfig (int iConfigId)
	Close the custom config file.
int	OGE_GetDefaultConfig ()
	Get the default config.
int	OGE_GetAppConfig ()
	Get the application config.
string	OGE_ReadConfigStr (int iConfigId, string sSectionName, string sFieldName, string sDefault)
	Read a string from the config.
int	OGE_ReadConfigInt (int iConfigId, string sSectionName, string sFieldName, int iDefault)
	Read an integer from the config.
double	OGE_ReadConfigFloat (int iConfigId, string sSectionName, string sFieldName, double fDefault)
	Read a floating-point value from the config.
bool	OGE_WriteConfigStr (int iConfigId, string sSectionName, string sFieldName, string sValue)
	Write a string into the config.
bool	OGE_WriteConfigInt (int iConfigId, string sSectionName, string sFieldName, int iValue)
	Write an integer value into the config.
bool	OGE_WriteConfigFloat (int iConfigId, string sSectionName, string sFieldName, double fValue)
	Write a floating-point value into the config.
bool	OGE_SaveConfig (int iConfigId)
	Save the config.
int	OGE_SaveDataToConfig (int iDataId, int iConfigId)
	Save the data into the config.
int	OGE_LoadDataFromConfig (int iDataId, int iConfigId)
	Load the data from the config.

---

Function Documentation

int OGE_CloseCustomConfig

(

int

iConfigId

)

Close the custom config file.

Parameters:

[in]

iConfigId

The ID of the config

Returns:

Return a non-negative number if succeed

int OGE_GetAppConfig

(

)

Get the application config.

Returns:

The ID of the config

int OGE_GetDefaultConfig

(

)

Get the default config.

Returns:

The ID of the config

int OGE_LoadDataFromConfig	(	int	iDataId,
		int	iConfigId
	)

Load the data from the config.

Parameters:

[in]	iDataId	The ID of the data
[in]	iConfigId	The ID of the config

Returns:

Return a non-negative number if succeed

int OGE_OpenCustomConfig

(

string

sConfigFile

)

Open custom configuration file (ini file)

Parameters:

[in]

sConfigFile

The path of the config file

Returns:

The ID of the config

double OGE_ReadConfigFloat	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		double	fDefault
	)

Read a floating-point value from the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	fDefault	The default value

Returns:

The floating-point value

int OGE_ReadConfigInt	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		int	iDefault
	)

Read an integer from the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	iDefault	The default value

Returns:

The integer value

string OGE_ReadConfigStr	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		string	sDefault
	)

Read a string from the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	sDefault	The default value

Returns:

The string

bool OGE_SaveConfig

(

int

iConfigId

)

Save the config.

Parameters:

[in]

iConfigId

The ID of the config

Returns:

Succeed or not

int OGE_SaveDataToConfig	(	int	iDataId,
		int	iConfigId
	)

Save the data into the config.

Parameters:

[in]	iDataId	The ID of the data
[in]	iConfigId	The ID of the config

Returns:

Return a non-negative number if succeed

bool OGE_WriteConfigFloat	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		double	fValue
	)

Write a floating-point value into the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	fValue	The floating-point value

Returns:

Succeed or not

bool OGE_WriteConfigInt	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		int	iValue
	)

Write an integer value into the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	iValue	The integer value

Returns:

Succeed or not

bool OGE_WriteConfigStr	(	int	iConfigId,
		string	sSectionName,
		string	sFieldName,
		string	sValue
	)

Write a string into the config.

Parameters:

[in]	iConfigId	The ID of the config
[in]	sSectionName	The section name
[in]	sFieldName	The field name
[in]	sValue	The string

Returns:

Succeed or not