RetCode Class Reference

Class used as return value to indicate successful or failed call. More...

#include <RetCode.h>

List of all members.

Public Types
enum	Code {   SUCCESS, FAIL, INV_PARAM, NOT_FOUND,   NO_MEMORY, NO_RESOURCES }
	Values used to indicate success or error. More...
Public Member Functions
	RetCode (Code retCode=SUCCESS)
	Construct RetCode object.
	operator Code ()
	Cast the object to numeric code value.
bool	IsOk ()
	Check if the status is successful.
bool	IsFailed ()
	Check if the status indicates failure.

---

Detailed Description

Class used as return value to indicate successful or failed call.

---

Member Enumeration Documentation

enum RetCode::Code

Values used to indicate success or error.

Enumerator:

SUCCESS	The call fully succeeded.
FAIL	Generic failure.
INV_PARAM	Provided parameter(s) is(are) invalid.
NOT_FOUND	Requested object not found.
NO_MEMORY	Failed to allocate memory.
NO_RESOURCES	Out of required resources.

---

Constructor & Destructor Documentation

RetCode::RetCode

(

Code

retCode = SUCCESS

)

[inline]

Construct RetCode object.

Should not be used directly - use RC macro instead.

Parameters:

retCode

Status code to return.

---

Member Function Documentation

bool RetCode::IsFailed

(

)

[inline]

Check if the status indicates failure.

bool RetCode::IsOk

(

)

[inline]

Check if the status is successful.

RetCode::operator Code

(

)

[inline]

Cast the object to numeric code value.

---

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

• include/RetCode.h