c_config.h File Reference

Go to the source code of this file.

Functions
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_create (const char *filepath, ConfigHandle *retConfig)
	C API of Legion configuration. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_clone (const ConfigHandle orig, ConfigHandle *clone)
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_delete (ConfigHandle config)
LEGIONRUNTIME_DLL const char *	legion_config_helpString (ConfigHandle config)
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_processParameters (ConfigHandle config, const char **paramNames, const char **paramValues, const int count)
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_processArguments (ConfigHandle config, int argc, char **argv, int *processedArgCount)
LEGIONRUNTIME_DLL LEG_Bool	legion_config_hasParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_Bool	legion_config_isParameterSet (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_Bool	legion_config_loadParameters (ConfigHandle config, const char *filename)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_Bool	legion_config_saveParameters (ConfigHandle config, const char *filename)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_registerBoolParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_registerIntParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_registerFloatParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_registerStringParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_setBoolParameter (ConfigHandle config, const char *name, const bool val)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_setIntParameter (ConfigHandle config, const char *name, const int val)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_setFloatParameter (ConfigHandle config, const char *name, const float val)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_setStringParameter (ConfigHandle config, const char *name, const char *val)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_Bool	legion_config_getBoolParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL int	legion_config_getIntParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL float	legion_config_getFloatParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL const char *	legion_config_getStringParameter (ConfigHandle config, const char *name)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL float	legion_config_getUnitMultiplier (ConfigHandle config, const char *param)
	C API to get/set/register/save configuration parameters. More...
LEGIONRUNTIME_DLL LEG_ReturnCode	legion_config_setUnitMultiplier (ConfigHandle config, const char *param, const float multiplier)
	C API to get/set/register/save configuration parameters. More...

Function Documentation

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_clone	(	const ConfigHandle	orig,
		ConfigHandle *	clone
	)

Clone configuration handle from an existing configuration handle

Parameters

[in]	orig	A existing configuration handle
[out]	clone	Return a clone configuration handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_create	(	const char *	filepath,
		ConfigHandle *	retConfig
	)

C API of Legion configuration.

Create configuration handle and load configuration from the input file

Parameters

[in]	filepath	The directory path where the Legion configuration file resides
[out]	retConfig	Return the created configuration handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_delete

(

ConfigHandle

config

)

Delete the configuration using configuration handle

Parameters

[in]

config

A existing configuration handle to delete

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure.

LEGIONRUNTIME_DLL LEG_Bool legion_config_getBoolParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL float legion_config_getFloatParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL int legion_config_getIntParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL const char* legion_config_getStringParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL float legion_config_getUnitMultiplier	(	ConfigHandle	config,
		const char *	param
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_Bool legion_config_hasParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL const char* legion_config_helpString

(

ConfigHandle

config

)

Get help info of Legion configuration

LEGIONRUNTIME_DLL LEG_Bool legion_config_isParameterSet	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_Bool legion_config_loadParameters	(	ConfigHandle	config,
		const char *	filename
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processArguments	(	ConfigHandle	config,
		int	argc,
		char **	argv,
		int *	processedArgCount
	)

Process Legion configuration arguments

Parameters

[in]	config	The configuration handle
[in]	argc	The argument count
[in]	argv	The argument values
[out]	processedArgCount	The number of recognized arguments processed

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processParameters	(	ConfigHandle	config,
		const char **	paramNames,
		const char **	paramValues,
		const int	count
	)

Process Legion configuration parameters

Parameters

[in]	config	The configuration handle
[in]	paramNames	The configuration parameter names
[in]	paramValues	The configuration parameter values
[in]	count	Count of parameter name-value pair to process

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerBoolParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerFloatParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerIntParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerStringParameter	(	ConfigHandle	config,
		const char *	name
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_Bool legion_config_saveParameters	(	ConfigHandle	config,
		const char *	filename
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setBoolParameter	(	ConfigHandle	config,
		const char *	name,
		const bool	val
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setFloatParameter	(	ConfigHandle	config,
		const char *	name,
		const float	val
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setIntParameter	(	ConfigHandle	config,
		const char *	name,
		const int	val
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setStringParameter	(	ConfigHandle	config,
		const char *	name,
		const char *	val
	)

C API to get/set/register/save configuration parameters.

LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setUnitMultiplier	(	ConfigHandle	config,
		const char *	param,
		const float	multiplier
	)

C API to get/set/register/save configuration parameters.