Tes::Runtime::Error Class Reference

This class encapsulated error code values returned by various processing functions. More...

List of all members.

Public Member Functions
	Error ()
	Create an error where Success is true.
	Error (int code)
	Create an error with the given code.
	Error (int code, long value)
	Create an error with the given code and value.
	Error (ErrorCode code)
	Create an error with an ErrorCode
	Error (ErrorCode code, long value)
	Create an error with an ErrorCode and value.
Public Attributes
int	Code
	The primary error code value.
long	Value
	An additional value for the error code.
Properties
bool	Success [get]
	Check the error code for success.
bool	Failed [get]
	Check the error code for failure.

---

Detailed Description

This class encapsulated error code values returned by various processing functions.

3rd Eye Scene uses error code in many places instead of exceptions for performance reasons.

---

Constructor & Destructor Documentation

Tes::Runtime::Error::Error

(

int

code

)

[inline]

Create an error with the given code.

Parameters:

code	The error code.

Tes::Runtime::Error::Error	(	int	code,
		long	value
	)		[inline]

Create an error with the given code and value.

Parameters:

code	The error code.
value	The error value associated with the code.

Tes::Runtime::Error::Error

(

ErrorCode

code

)

[inline]

Create an error with an ErrorCode

Parameters:

code	The error code.

Tes::Runtime::Error::Error	(	ErrorCode	code,
		long	value
	)		[inline]

Create an error with an ErrorCode and value.

Parameters:

code	The error code.
value	The error value associated with the code.

---

Member Data Documentation

int Tes::Runtime::Error::Code

The primary error code value.

Normally correlates to a value in ErrorCode.

---

Property Documentation

bool Tes::Runtime::Error::Failed [get]

Check the error code for failure.

Returns:

True if the Code is non zero.

bool Tes::Runtime::Error::Success [get]

Check the error code for success.

Returns:

True if the Code is zero.

---

The documentation for this class was generated from the following file:

• Error.cs