KError Class Reference

#include <kerror.h>

List of all members.

---

Detailed Description

This class provides access to the last error integer ID and is used for translating from integer error ID to strings.

Internally a KError instance maintains a translation table from integer IDs to strings. Note that different classes and systems in FBX (e.g. KFbxSdkManager) have different sets of error codes, and maintain different instances of the KError class. The translation table is an array of strings (char*) and the index into the string table is assumed to be the error number.

See also:

KFbxSdkManager::EError

KFbxSdkManager::GetError()

Definition at line 57 of file kerror.h.

Public Member Functions
	KError ()
	Default constructor.
	KError (char *pStringArray[], int pErrorCount)
	Creates a KError from an array of strings.
	~KError ()
	Destructor.
void	Reset (char *pStringArray[], int pErrorCount)
	Reset the object (clears the last error) and use the received error string table.
int	GetErrorCount () const
	Get the size of the error string table.
char *	GetErrorString (int pIndex) const
	Get the error message string.
void	SetLastError (int pIndex, const char *pString)
	Set the last error ID and the last error string.
void	SetLastErrorID (int pIndex)
	Set the last error index.
int	GetLastErrorID () const
	Return the last error index.
const char *	GetLastErrorString () const
	Get the message string associated with the last error.
void	SetLastErrorString (const char *pString)
	Set the message string associated with the last error.
void	ClearLastError ()
	Reset the last error.

---

Constructor & Destructor Documentation

KError

(

)

Default constructor.

KError	(	char *	pStringArray[],
		int	pErrorCount
	)

Creates a KError from an array of strings.

An error code is treated as index into the array of strings when looking up the error code.

Parameters:

	pStringArray	The error string table in use.
	pErrorCount	Number of elements in the error string table.

~KError

(

)

Destructor.

---

Member Function Documentation

void Reset	(	char *	pStringArray[],
		int	pErrorCount
	)

Reset the object (clears the last error) and use the received error string table.

Parameters:

	pStringArray	The error string table in use.
	pErrorCount	Number of elements in the error string table.

int GetErrorCount

(

)

const

Get the size of the error string table.

Returns:

Number of elements in the error string table.

char* GetErrorString

(

int

pIndex

)

const

Get the error message string.

Parameters:

pIndex

Error index.

Returns:

Error string.

void SetLastError	(	int	pIndex,
		const char *	pString
	)

Set the last error ID and the last error string.

Parameters:

	pIndex	Error index.
	pString	Error string.

Remarks:

This method will also set the last error string to the default string value contained in the error string table for this error ID.

void SetLastErrorID

(

int

pIndex

)

Set the last error index.

Parameters:

pIndex

Error index.

Remarks:

This method will also set the last error string to the default string value contained in the error string table for this error index.

int GetLastErrorID

(

)

const

Return the last error index.

Returns:

The last error index or -1 if none is set.

const char* GetLastErrorString

(

)

const

Get the message string associated with the last error.

Returns:

Error string or empty string if none is set.

void SetLastErrorString

(

const char *

pString

)

Set the message string associated with the last error.

Parameters:

pString

Error string. This method should be called after KError::SetLastErrorID() in order to customize the error string.

void ClearLastError

(

)

Reset the last error.