returncodes.h File Reference

Common return codes. More...

This graph shows which files directly or indirectly include this file:


Enumerations
enum	rc_ReturnCode_t { RC_OK = 0, RC_NOT_FOUND = -1, RC_OUT_OF_RANGE = -2, RC_NO_MEMORY = -3, RC_NOT_PERMITTED = -4, RC_UNSPECIFIED_ERROR = -5, RC_COMMUNICATION_ERROR = -6, RC_TIMEOUT = -7, RC_WOULD_BLOCK = -8, RC_DEADLOCK = -9, RC_BAD_FORMAT = -10, RC_DUPLICATE = -11, RC_BAD_PARAMETER = -12, RC_CLOSED = -13, RC_IO_ERROR = -14, RC_NOT_IMPLEMENTED = -15, RC_BUSY = -16, RC_NOT_INITIALIZED = -17, RC_END = -18, RC_NOT_AVAILABLE = -19 }
	Return code constants. More...
Functions
const char *	rc_ReturnCodeToString (rc_ReturnCode_t n)
	Convert a rc_ReturnCode_t into string representing the ReturnCode Returns a const string or NULL if the code does not exist.
rc_ReturnCode_t	rc_StringToReturnCode (const char *name)
	Convert a ReturnCode string into a rc_ReturnCode_t value Returns the code value (negative or null value) or 1 is the string does not represent a known error name.

Detailed Description

Common return codes.

This header provides an homogeneous return code namespace for all framework APIs.

Return code constants.

All error codes are negative.

Enumerator:

RC_OK	Successful.
RC_NOT_FOUND	The referenced item does not exist or could not be found.
RC_OUT_OF_RANGE	An index or other value is out of range.
RC_NO_MEMORY	Insufficient memory is available.
RC_NOT_PERMITTED	Current user does not have permission to perform requested action.
RC_UNSPECIFIED_ERROR	An unspecified error happened.
RC_COMMUNICATION_ERROR	Communications error.
RC_TIMEOUT	A time-out occurred.
RC_WOULD_BLOCK	Would have blocked if non-blocking behavior was not requested.
RC_DEADLOCK	Would have caused a deadlock.
RC_BAD_FORMAT	Inputs or data are not formated correctly.
RC_DUPLICATE	Duplicate entry found or operation already performed.
RC_BAD_PARAMETER	Parameter is not valid.
RC_CLOSED	The file, stream or object was closed.
RC_IO_ERROR	An IO error occurred.
RC_NOT_IMPLEMENTED	This feature is not implemented.
RC_BUSY	The component or service is busy.
RC_NOT_INITIALIZED	The service or object is not initialized.
RC_END	The file, stream or buffer reached the end.
RC_NOT_AVAILABLE	The service is not available.