gxLog Class Reference

Inheritance diagram for gxLog:

List of all members.

---

Detailed Description

Class for the GX LOG functions.

Public Member Functions
void	_Set (gxi32 level, const char *file, gxi32 line, const char *pretty_function)
	Locks the mutex and settings local variables.
void	_WriteLog (const wchar_t *str,...) throw (gxError)
	Writes a log and unlocks the mutex.
void	_WriteLog (const char *str,...) throw (gxError)
	Writes a log and unlocks the mutex.
	gxLog () throw (gxError)
	Class initialization.
	gxLog (const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with place of the properties and name of the module.
	gxLog (const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with place of the properties and name of the module.
	gxLog (gxInStr propname, gxInStr modname) throw (gxError)
	Class initialization with place of the properties and name of the module.
	gxLog (gxInStr propname) throw (gxError)
	Class initialization with place of the properties and name of the module.
	gxLog (gxInAStr propname, gxInAStr modname) throw (gxError)
	Class initialization with place of the properties and name of the module.
	gxLog (gxInAStr propname) throw (gxError)
	Class initialization with place of the properties.
	~gxLog ()
	Class termination.
void	Dispose (void)
	It disposes the class.
bool	WriteLogv (gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str, va_list args) throw (gxError)
	Writes a log with debug information.
bool	WriteLogv (gxi32 level, const wchar_t *str, va_list args) throw (gxError)
	Writes a log.
bool	WriteLogv (gxi32 level, const char *file, gxi32 line, const char *function, const char *str, va_list args) throw (gxError)
	Writes a log with debug information.
bool	WriteLogv (gxi32 level, const char *str, va_list args) throw (gxError)
	Writes a log.
bool	WriteLog (gxi32 level, const char *file, gxi32 line, const char *function, const wchar_t *str,...) throw (gxError)
	Writes a log with debug information.
bool	WriteLog (gxi32 level, const wchar_t *str,...) throw (gxError)
	Writes a log.
bool	WriteLog (gxi32 level, const char *file, gxi32 line, const char *function, const char *str,...) throw (gxError)
	Writes a log with debug information.
bool	WriteLog (gxi32 level, const char *str,...) throw (gxError)
	Writes a log.
bool	WriteEmergency (const wchar_t *str,...) throw (gxError)
	Writes a log with emergency level.
bool	WriteEmergency (const char *str,...) throw (gxError)
	Writes a log with emergency level.
bool	WriteFatal (const wchar_t *str,...) throw (gxError)
	Writes a log with fatal level.
bool	WriteFatal (const char *str,...) throw (gxError)
	Writes a log with fatal level.
bool	WriteError (const wchar_t *str,...) throw (gxError)
	Writes a log with error level.
bool	WriteError (const char *str,...) throw (gxError)
	Writes a log with error level.
bool	WriteWarning (const wchar_t *str,...) throw (gxError)
	Writes a log with warning level.
bool	WriteWarning (const char *str,...) throw (gxError)
	Writes a log with warning level.
bool	WriteInfo (const wchar_t *str,...) throw (gxError)
	Writes a log with information level.
bool	WriteInfo (const char *str,...) throw (gxError)
	Writes a log with information level.
bool	WriteInfo2 (const wchar_t *str,...) throw (gxError)
	Writes a log with information level 2.
bool	WriteInfo2 (const char *str,...) throw (gxError)
	Writes a log with information level 2.
bool	WriteInfo3 (const wchar_t *str,...) throw (gxError)
	Writes a log with information level 3.
bool	WriteInfo3 (const char *str,...) throw (gxError)
	Writes a log with information level 3.
bool	WriteLog (gxi32 level, gxInStr file, gxi32 line, gxInStr function, gxInStr str) throw (gxError)
	Writes a log with debug information.
bool	WriteLog (gxi32 level, gxInStr str) throw (gxError)
	Writes a log with debug information.
bool	WriteEmergency (gxInStr str) throw (gxError)
	Writes a log with emergency level.
bool	WriteFatal (gxInStr str) throw (gxError)
	Writes a log with fatal level.
bool	WriteError (gxInStr str) throw (gxError)
	Writes a log with error level.
bool	WriteWarning (gxInStr str) throw (gxError)
	Writes a log with warning level.
bool	WriteInfo (gxInStr str) throw (gxError)
	Writes a log with information level.
bool	WriteInfo2 (gxInStr str) throw (gxError)
	Writes a log with information level 2.
bool	WriteInfo3 (gxInStr str) throw (gxError)
	Writes a log with information level 3.
bool	WriteLog (gxi32 level, gxInAStr file, gxi32 line, gxInAStr function, gxInAStr str) throw (gxError)
	Writes a log with debug information.
bool	WriteLog (gxi32 level, gxInAStr str) throw (gxError)
	Writes a log with debug information.
bool	WriteEmergency (gxInAStr str) throw (gxError)
	Writes a log with emergency level.
bool	WriteFatal (gxInAStr str) throw (gxError)
	Writes a log with fatal level.
bool	WriteError (gxInAStr str) throw (gxError)
	Writes a log with error level.
bool	WriteWarning (gxInAStr str) throw (gxError)
	Writes a log with warning level.
bool	WriteInfo (gxInAStr str) throw (gxError)
	Writes a log with information level.
bool	WriteInfo2 (gxInAStr str) throw (gxError)
	Writes a log with information level 2.
bool	WriteInfo3 (gxInAStr str) throw (gxError)
	Writes a log with information level 3.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInAStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (ASCII version).
bool	Close (void) throw (gxError)
	Closes a previously opened module.
bool	IsValid (void) const
	Checks if the handle of the module is valid.
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxLog

(

)

throw (gxError) [inline]

Class initialization.

References gx_openmodule().

gxLog	(	const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with place of the properties and name of the module.

(Unicode version)

Parameters:

	propname	Place of the properties in the property tree. (Name of the property group)
	modname	Name of the module.

References gx_openmodule().

gxLog	(	const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with place of the properties and name of the module.

(ASCII version)

Parameters:

	propname	Place of the properties in the property tree. (Name of the property group)
	modname	Name of the module.

References gx_openmodule().

gxLog	(	gxInStr	propname,
		gxInStr	modname
	)			throw (gxError) [inline]

Class initialization with place of the properties and name of the module.

(Unicode version)

Parameters:

	propname	Place of the properties in the property tree. (Name of the property group)
	modname	Name of the module.

References gx_openmodule().

gxLog

(

gxInStr

propname

)

throw (gxError) [inline]

Class initialization with place of the properties and name of the module.

(Unicode version)

Parameters:

propname

Place of the properties in the property tree. (Name of the property group)

References gx_openmodule().

gxLog	(	gxInAStr	propname,
		gxInAStr	modname
	)			throw (gxError) [inline]

Class initialization with place of the properties and name of the module.

(ASCII version)

Parameters:

	propname	Place of the properties in the property tree. (Name of the property group)
	modname	Name of the module.

References gx_openmodule().

gxLog

(

gxInAStr

propname

)

throw (gxError) [inline]

Class initialization with place of the properties.

(ASCII version)

Parameters:

propname

Place of the properties in the property tree. (Name of the property group)

References gx_openmodule().

~gxLog

(

)

[inline]

Class termination.

---

Member Function Documentation

void _Set	(	gxi32	level,
		const char *	file,
		gxi32	line,
		const char *	pretty_function
	)			[inline]

Locks the mutex and settings local variables.

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file where the function is called. (In debug mode)
	line	Line number of the source file where the function is called. (In debug mode)
	pretty_function	Name of the function where the log function is called. (In debug mode)

void _WriteLog	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log and unlocks the mutex.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

References gx_writelogv().

void _WriteLog	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log and unlocks the mutex.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

References gx_writelogv().

void Dispose

(

void

)

[inline]

It disposes the class.

call the base class

Reimplemented from gxHandle.

References gxHandle::Dispose().

bool WriteLogv	(	gxi32	level,
		const char *	file,
		gxi32	line,
		const char *	function,
		const wchar_t *	str,
		va_list	args
	)			throw (gxError) [inline]

Writes a log with debug information.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file where the function is called (in debug mode).
	line	Line number of the source file where the function is called (in debug mode).
	function	Name of the function where the log function is called (in debug mode).
	str	Description text of the log.
	args	Arguments for the log function.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLogv	(	gxi32	level,
		const wchar_t *	str,
		va_list	args
	)			throw (gxError) [inline]

Writes a log.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Description text of the log.
	args	Arguments for the log function.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLogv	(	gxi32	level,
		const char *	file,
		gxi32	line,
		const char *	function,
		const char *	str,
		va_list	args
	)			throw (gxError) [inline]

Writes a log with debug information.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file where the function is called (in debug mode).
	line	Line number of the source file where the function is called (in debug mode).
	function	Name of the function where the log function is called (in debug mode).
	str	Description text of the log.
	args	Arguments for the log function.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLogv	(	gxi32	level,
		const char *	str,
		va_list	args
	)			throw (gxError) [inline]

Writes a log.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Description text of the log.
	args	Arguments for the log function.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLog	(	gxi32	level,
		const char *	file,
		gxi32	line,
		const char *	function,
		const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with debug information.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file where the function is called (in debug mode).
	line	Line number of the source file where the function is called (in debug mode).
	function	Name of the function where the log function is called (in debug mode).
	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLog	(	gxi32	level,
		const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLog	(	gxi32	level,
		const char *	file,
		gxi32	line,
		const char *	function,
		const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with debug information.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file where the function is called (in debug mode).
	line	Line number of the source file where the function is called (in debug mode).
	function	Name of the function where the log function is called (in debug mode).
	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteLog	(	gxi32	level,
		const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelogv().

bool WriteEmergency	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with emergency level.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_EMERG.

bool WriteEmergency	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with emergency level.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_EMERG.

bool WriteFatal	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with fatal level.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_FATAL.

bool WriteFatal	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with fatal level.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_FATAL.

bool WriteError	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with error level.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_ERROR.

bool WriteError	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with error level.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_ERROR.

bool WriteWarning	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with warning level.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_WARN.

bool WriteWarning	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with warning level.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_WARN.

bool WriteInfo	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO.

bool WriteInfo	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO.

bool WriteInfo2	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level 2.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO2.

bool WriteInfo2	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level 2.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO2.

bool WriteInfo3	(	const wchar_t *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level 3.

(Unicode version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO3.

bool WriteInfo3	(	const char *	str,
			...
	)			throw (gxError) [inline]

Writes a log with information level 3.

(ASCII version)

Parameters:

	str	Description text of the log.
	...	Arguments for the log function (like printf).

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO3.

bool WriteLog	(	gxi32	level,
		gxInStr	file,
		gxi32	line,
		gxInStr	function,
		gxInStr	str
	)			throw (gxError) [inline]

Writes a log with debug information.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file the function is called from (in debug mode).
	line	Line number of the source file the function is called from (in debug mode).
	function	Name of the function the log function is called from (in debug mode).
	str	Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelog().

bool WriteLog	(	gxi32	level,
		gxInStr	str
	)			throw (gxError) [inline]

Writes a log with debug information.

(Unicode version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelog().

bool WriteEmergency

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with emergency level.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_EMERG, and gx_writelog().

bool WriteFatal

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with fatal level.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_FATAL, and gx_writelog().

bool WriteError

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with error level.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_ERROR, and gx_writelog().

bool WriteWarning

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with warning level.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_WARN, and gx_writelog().

bool WriteInfo

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with information level.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO, and gx_writelog().

bool WriteInfo2

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with information level 2.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO2, and gx_writelog().

bool WriteInfo3

(

gxInStr

str

)

throw (gxError) [inline]

Writes a log with information level 3.

(Unicode version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO3, and gx_writelog().

bool WriteLog	(	gxi32	level,
		gxInAStr	file,
		gxi32	line,
		gxInAStr	function,
		gxInAStr	str
	)			throw (gxError) [inline]

Writes a log with debug information.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	file	Name of the source file the function is called from (in debug mode).
	line	Line number of the source file the function is called from (in debug mode).
	function	Name of the function the log function is called from (in debug mode).
	str	Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelog().

bool WriteLog	(	gxi32	level,
		gxInAStr	str
	)			throw (gxError) [inline]

Writes a log with debug information.

(ASCII version)

Parameters:

	level	Level of the log item. (see GX_LOGLEVELS)
	str	Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writelog().

bool WriteEmergency

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with emergency level.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_EMERG, and gx_writelog().

bool WriteFatal

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with fatal level.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_FATAL, and gx_writelog().

bool WriteError

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with error level.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_ERROR, and gx_writelog().

bool WriteWarning

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with warning level.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_WARN, and gx_writelog().

bool WriteInfo

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with information level.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO, and gx_writelog().

bool WriteInfo2

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with information level 2.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO2, and gx_writelog().

bool WriteInfo3

(

gxInAStr

str

)

throw (gxError) [inline]

Writes a log with information level 3.

(ASCII version)

Parameters:

str

Descriptive text of the log.

Returns:

An exception is thrown or false is returned in case of error.

References GX_INFO3, and gx_writelog().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open

(

gxInStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open

(

gxInAStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close

(

void

)

throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool IsValid

(

void

)

const [inline, inherited]

Checks if the handle of the module is valid.

Returns:

In case of existing handle the return value is true.

Reimplemented in gxImage, gxTrafo, gxGZip, and gxZip.

Referenced by gxHandle::Close(), gxHandle::gxHandle(), gxImage::gxImage(), gxTrafo::gxTrafo(), gxZip::IsValid(), gxGZip::IsValid(), gxTrafo::IsValid(), and gxImage::IsValid().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().