OrxParam

Data Structures
struct	orxPARAM

Macros
#define	orxPARAM_KU32_FLAG_MULTIPLE_ALLOWED   0x00000001
#define	orxPARAM_KU32_FLAG_NONE   0x00000000
#define	orxPARAM_KU32_FLAG_STOP_ON_ERROR   0x00000002

Typedefs
typedef orxSTATUS(orxFASTCALL *	orxPARAM_INIT_FUNCTION) (orxU32 _u32NbParam, const orxSTRING _azParams[])

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxParam_DisplayHelp ()
orxDLLAPI void orxFASTCALL	orxParam_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	orxParam_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxParam_Register (const orxPARAM *_pstParam)
orxDLLAPI orxSTATUS orxFASTCALL	orxParam_SetArgs (orxU32 _u32NbParams, orxSTRING _azParams[])
orxDLLAPI void orxFASTCALL	orxParam_Setup ()

Detailed Description

Param module Module that handles command line parameters

Macro Definition Documentation

#define orxPARAM_KU32_FLAG_MULTIPLE_ALLOWED   0x00000001

It's possible to have multiple instance of the same param

Definition at line 54 of file orxParam.h.

#define orxPARAM_KU32_FLAG_NONE   0x00000000

No flags (default behaviour)

Definition at line 53 of file orxParam.h.

#define orxPARAM_KU32_FLAG_STOP_ON_ERROR   0x00000002

If the param extra flag parsing fails, stop the engine

Definition at line 55 of file orxParam.h.

Typedef Documentation

typedef orxSTATUS(orxFASTCALL * orxPARAM_INIT_FUNCTION) (orxU32 _u32NbParam, const orxSTRING _azParams[])

Callback definition (called when a parameter has been found

Parameters

[in]	_u32NbParam	Number of extra parameters read for this option
[in]	_azParams	Array of extra parameters (the first one is always the option name)

Returns

Returns orxSTATUS_SUCCESS if read information is correct, orxSTATUS_FAILURE if a problem occurred

Definition at line 62 of file orxParam.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxParam_DisplayHelp

(

)

Displays help if requested

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxParam_Exit

(

)

Exits from the param module

orxDLLAPI orxSTATUS orxFASTCALL orxParam_Init

(

)

Inits the param Module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxParam_Register

(

const orxPARAM *

_pstParam

)

Registers a new parameter

Parameters

[in]

_pstParam

Information about the option to register

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxParam_SetArgs	(	orxU32	_u32NbParams,
		orxSTRING	_azParams[]
	)

Sets the command line arguments

Parameters

[in]	_u32NbParams	Number of read parameters
[in]	_azParams	List of parameters

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxParam_Setup

(

)

Setups param module