Return Codes

Defines

#define MB_SUCCESS   0
 Return Code: Success.
#define MB_ERR_MEMALLOC   1
 Return Code: Memory allocation error.
#define MB_ERR_INVALID   2
 Return Code: Input error.
#define MB_ERR_LOCKED   3
 Return Code: Object locked.
#define MB_ERR_MPI   4
 Return Code: MPI Error.
#define MB_ERR_ENV   5
 Return Code: Environment Error.
#define MB_ERR_OVERFLOW   6
 Return Code: Overflow Error.
#define MB_ERR_INTERNAL   7
 Return Code: Internal Error.
#define MB_ERR_USER   8
 Return Code: User Error.
#define MB_ERR_NOTREADY   9
 Return Code: Not Ready.
#define MB_ERR_DUPLICATE   10
 Return Code: Duplicate value.
#define MB_ERR_NOT_FOUND   11
 Return Code: Required value not found.
#define MB_ERR_DISABLED   12
 Return Code: Routine disabled.
#define MB_SUCCESS_2   100
 Return Code: Success.
#define MB_ERR_NOT_IMPLEMENTED   111
 Return Code: Not Implemented.
#define MB_ERR_DEPRECATED   123
 Return Code: Funtion deprecated.

Detailed Description

All Message Board routines return an int-based return code. It is recommended that users always check the return code of all routine calls, and include sufficient error handling if the routine ends errorneously.

The following is a list of possible return codes and their description.


Define Documentation

#define MB_SUCCESS   0

Return Code: Success.

Specifies a successful execution.

#define MB_ERR_MEMALLOC   1

Return Code: Memory allocation error.

Failed to allocate required memory. We have most likely exhausted all available memory on the system. Use the DEBUG version of libmboard for more information on where this occured.

#define MB_ERR_INVALID   2

Return Code: Input error.

One or more of the given input parameter is invalid.

#define MB_ERR_LOCKED   3

Return Code: Object locked.

Object has being locked by another process.

#define MB_ERR_MPI   4

Return Code: MPI Error.

An MPI related error has occured. Use the DEBUG version of libmboard for more information on where this occured.

#define MB_ERR_ENV   5

Return Code: Environment Error.

Specifies error due to uninitalised or invalid environment state. This may be due to users calling Message Board routines before initialising the environment with MB_Env_Init(), or after the environment has been finalised with MB_Env_Finalise().

#define MB_ERR_OVERFLOW   6

Return Code: Overflow Error.

Specifies error due to an overflow in internal variable or storage. Use the DEBUG version of libmboard for more information on where this occured.

#define MB_ERR_INTERNAL   7

Return Code: Internal Error.

Specifies internal implementation error. Possibly a bug. Use the DEBUG version of libmboard for more information on where this occured.

#define MB_ERR_USER   8

Return Code: User Error.

Specifies error due to something the user has done (or not done). See documentation or any output message for details.

#define MB_ERR_NOTREADY   9

Return Code: Not Ready.

The requested operation cannot be completed as the target object is not ready. Refer to the function documentation for details.

#define MB_ERR_DUPLICATE   10

Return Code: Duplicate value.

Duplicate value was entered or found. Refer to function documentaion for details

#define MB_ERR_NOT_FOUND   11

Return Code: Required value not found.

Refer to function documentaion for details.

#define MB_ERR_DISABLED   12

Return Code: Routine disabled.

The requested functionality has been disabled.

Refer to function documentaion for details.

#define MB_SUCCESS_2   100

Return Code: Success.

Specifies a successful execution (but with routine specific connotations).

#define MB_ERR_NOT_IMPLEMENTED   111

Return Code: Not Implemented.

Requested operation has not been implemented.

#define MB_ERR_DEPRECATED   123

Return Code: Funtion deprecated.

The function is deprecated. Please use an alternative function.


Generated on 1 Oct 2009 for libmboard by  doxygen 1.6.1