Error handling

---

Detailed Description

Functions for error handling.

Modules
	Examples
	Error handling examples gxerror01 - Set, get error example gxerror02 - Clear error example gxerror03 - Append, prepend error example gxerror04 - Threaded error handling example.
Functions
static int	gx_geterror (int *code, wchar_t *string, int maxlen)
	You can query the error code and string with this function (Unicode version).
static int	gx_geterrora (int *code, char *string, int maxlen)
	You can query the error code and string with this function (ASCII version).
static int	gx_geterrorcode (void)
	You can query the error code with this function.
static int	gx_seterrorfv (int flags, int code, const wchar_t *wformat, va_list args)
	Updates a thread-local error buffer (Unicode version).
static int	gx_seterrorafv (int flags, int code, const char *wformat, va_list args)
	Updates a thread-local error buffer (ASCII version).
static int	gx_seterrorv (int code, const wchar_t *wformat, va_list args)
	Clears and updates a thread-local error buffer (Unicode version).
static int	gx_seterrorav (int code, const char *wformat, va_list args)
	Clears and updates a thread-local error buffer (ASCII version).
static int	gx_appenderrorv (int code, const wchar_t *wformat, va_list args)
	Appends a thread-local error buffer (Unicode version).
static int	gx_appenderrorav (int code, const char *wformat, va_list args)
	Appends a thread-local error buffer (ASCII version).
static int	gx_prependerrorv (int code, const wchar_t *wformat, va_list args)
	Prepends a thread-local error buffer (Unicode version).
static int	gx_prependerrorav (int code, const char *wformat, va_list args)
	Prepends a thread-local error buffer (ASCII version).
static int	gx_seterrorf (int flags, int code, const wchar_t *wformat,...)
	Updates a thread-local error buffer with variable number of arguments (.
static int	gx_seterroraf (int flags, int code, const char *wformat,...)
	Updates a thread-local error buffer with variable number of arguments (.
static int	gx_clearerror (void)
	Clears a thread-local error buffer.
static int	gx_seterrorcodef (int flags, int code)
	Updates a thread-local error buffer with flags and error code.
static int	gx_seterrorcode (int code)
	Updates a thread-local error buffer with error code.
static int	gx_appenderrorcode (int code)
	Appends a thread-local error buffer with error code.
static int	gx_prependerrorcode (int code)
	Prepends a thread-local error buffer with error code.
static int	gx_seterror (int code, const wchar_t *wformat,...)
	Clears and updates a thread-local error buffer (Unicode version).
static int	gx_seterrora (int code, const char *wformat,...)
	Clears and updates a thread-local error buffer (ASCII version).
static int	gx_appenderror (int code, const wchar_t *wformat,...)
	Appends a thread-local error buffer (Unicode version).
static int	gx_appenderrora (int code, const char *wformat,...)
	Appends a thread-local error buffer (ASCII version).
static int	gx_prependerror (int code, const wchar_t *wformat,...)
	Prepends a thread-local error buffer (Unicode version).
static int	gx_prependerrora (int code, const char *wformat,...)
	Prepends a thread-local error buffer (ASCII version).
static int	gx_updateerrtable (int nitems, const gxERRITEM *items)
	Updates the error table in the memory.
static int	gx_pusherror (void)
	Pushes the error code and string to the error stack.
static int	gx_poperror (void)
	Pops the error code and string from the error stack.

---

Function Documentation

static int gx_geterror	(	int *	code,
		wchar_t *	string,
		int	maxlen
	)			[static]

You can query the error code and string with this function (Unicode version).

Parameters:

	code	The function will update it with the error code (Can be NULL).
	string	Memory pointer where the function writes the descriptive text of the error. Can be NULL, in that case there is no description.
	maxlen	Length of the memory area in characters (not bytes).

Returns:

It returns error code.

References gx_call().

static int gx_geterrora	(	int *	code,
		char *	string,
		int	maxlen
	)			[static]

You can query the error code and string with this function (ASCII version).

Parameters:

	code	The function will update it with the error code (Can be NULL).
	string	Memory pointer where the function writes the descriptive text of the error. Can be NULL, in that case there is no description.
	maxlen	Length of the memory area in characters (not bytes).

Returns:

The error code.

References gx_call().

static int gx_geterrorcode

(

void

)

[static]

You can query the error code with this function.

Returns:

The error code.

References gx_call().

static int gx_seterrorfv	(	int	flags,
		int	code,
		const wchar_t *	wformat,
		va_list	args
	)			[static]

Updates a thread-local error buffer (Unicode version).

Parameters:

	flags	Clear/Insert/Append mode ( see GX_ERR_FLAG_CLEAR, GX_ERR_FLAG_APPEND, GX_ERR_FLAG_PREPEND, GX_ERR_FLAG_APPMODE, GX_ERR_FLAG_LOCAL )
	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_appenderrorv(), gx_prependerrorv(), gx_seterrorf(), and gx_seterrorv().

static int gx_seterrorafv	(	int	flags,
		int	code,
		const char *	wformat,
		va_list	args
	)			[static]

Updates a thread-local error buffer (ASCII version).

Parameters:

	flags	Clear/Insert/Append mode ( see GX_ERR_FLAG_CLEAR, GX_ERR_FLAG_APPEND, GX_ERR_FLAG_PREPEND, GX_ERR_FLAG_APPMODE, GX_ERR_FLAG_LOCAL )
	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_appenderrorav(), gx_prependerrorav(), gx_seterroraf(), and gx_seterrorav().

static int gx_seterrorv	(	int	code,
		const wchar_t *	wformat,
		va_list	args
	)			[static]

Clears and updates a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorfv().

Referenced by gx_seterror().

static int gx_seterrorav	(	int	code,
		const char *	wformat,
		va_list	args
	)			[static]

Clears and updates a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorafv().

Referenced by gx_seterrora().

static int gx_appenderrorv	(	int	code,
		const wchar_t *	wformat,
		va_list	args
	)			[static]

Appends a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorfv().

Referenced by gx_appenderror().

static int gx_appenderrorav	(	int	code,
		const char *	wformat,
		va_list	args
	)			[static]

Appends a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorafv().

Referenced by gx_appenderrora().

static int gx_prependerrorv	(	int	code,
		const wchar_t *	wformat,
		va_list	args
	)			[static]

Prepends a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorfv().

Referenced by gx_prependerror().

static int gx_prependerrorav	(	int	code,
		const char *	wformat,
		va_list	args
	)			[static]

Prepends a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	args	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorafv().

Referenced by gx_prependerrora().

static int gx_seterrorf	(	int	flags,
		int	code,
		const wchar_t *	wformat,
			...
	)			[static]

Updates a thread-local error buffer with variable number of arguments (.

..).

Parameters:

	flags	Clear/Insert/Append mode ( see GX_ERR_FLAG_CLEAR, GX_ERR_FLAG_APPEND, GX_ERR_FLAG_PREPEND, GX_ERR_FLAG_APPMODE, GX_ERR_FLAG_LOCAL )
	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for printf).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorfv().

Referenced by gx_appenderrorcode(), gx_clearerror(), gx_prependerrorcode(), gx_seterrorcode(), and gx_seterrorcodef().

static int gx_seterroraf	(	int	flags,
		int	code,
		const char *	wformat,
			...
	)			[static]

Updates a thread-local error buffer with variable number of arguments (.

..) (ASCII version).

Parameters:

	flags	Clear/Insert/Append mode ( see GX_ERR_FLAG_CLEAR, GX_ERR_FLAG_APPEND, GX_ERR_FLAG_PREPEND, GX_ERR_FLAG_APPMODE, GX_ERR_FLAG_LOCAL )
	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for printf).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorafv().

static int gx_clearerror

(

void

)

[static]

Clears a thread-local error buffer.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorf().

static int gx_seterrorcodef	(	int	flags,
		int	code
	)			[static]

Updates a thread-local error buffer with flags and error code.

Parameters:

	flags	Clear/Insert/Append mode ( see GX_ERR_FLAG_CLEAR, GX_ERR_FLAG_APPEND, GX_ERR_FLAG_PREPEND, GX_ERR_FLAG_APPMODE, GX_ERR_FLAG_LOCAL )
	code	Error code (Specified in gxerror.h or error codes also used in modules or system).

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorf().

static int gx_seterrorcode

(

int

code

)

[static]

Updates a thread-local error buffer with error code.

Parameters:

code

Error code (Specified in gxerror.h or error codes also used in modules or system).

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorf().

static int gx_appenderrorcode

(

int

code

)

[static]

Appends a thread-local error buffer with error code.

Parameters:

code

Error code (Specified in gxerror.h or error codes also used in modules or system).

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorf().

static int gx_prependerrorcode

(

int

code

)

[static]

Prepends a thread-local error buffer with error code.

Parameters:

code

Error code (Specified in gxerror.h or error codes also used in modules or system).

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorf().

static int gx_seterror	(	int	code,
		const wchar_t *	wformat,
			...
	)			[static]

Clears and updates a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string. (like for wprintf, use hs and ls instead of s)
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorv().

static int gx_seterrora	(	int	code,
		const char *	wformat,
			...
	)			[static]

Clears and updates a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_seterrorav().

static int gx_appenderror	(	int	code,
		const wchar_t *	wformat,
			...
	)			[static]

Appends a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_appenderrorv().

static int gx_appenderrora	(	int	code,
		const char *	wformat,
			...
	)			[static]

Appends a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_appenderrorav().

static int gx_prependerror	(	int	code,
		const wchar_t *	wformat,
			...
	)			[static]

Prepends a thread-local error buffer (Unicode version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_prependerrorv().

static int gx_prependerrora	(	int	code,
		const char *	wformat,
			...
	)			[static]

Prepends a thread-local error buffer (ASCII version).

Parameters:

	code	Error code (Specified in gxerror.h or error codes also used in modules or system).
	wformat	Format string (like for wprintf, use hs and ls instead of s).
	...	Arguments for format strings.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_prependerrorav().

static int gx_updateerrtable	(	int	nitems,
		const gxERRITEM *	items
	)			[static]

Updates the error table in the memory.

Parameters:

	nitems	Number of items in the table.
	items	Items of the table.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

static int gx_pusherror

(

void

)

[static]

Pushes the error code and string to the error stack.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_convertvariantbypath(), gx_convertvariantchild(), gx_convertvariantitem(), gx_createvariantchild(), and gx_createvariantitem().

static int gx_poperror

(

void

)

[static]

Pops the error code and string from the error stack.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_convertvariantbypath(), gx_convertvariantchild(), gx_convertvariantitem(), gx_createvariantchild(), and gx_createvariantitem().