Go to the source code of this file.
Defines |
#define | XN_STATUS_MAKE(group, code) ((group << 16) | code) |
#define | XN_STATUS_GROUP(status) (status >> 16) |
#define | XN_STATUS_CODE(status) (status & 0x0000FFFF) |
#define | XN_STATUS_MESSAGE_MAP_START_FROM(group, first) |
#define | XN_STATUS_MESSAGE_MAP_START(group) XN_STATUS_MESSAGE_MAP_START_FROM(group, 0) |
#define | XN_STATUS_MESSAGE(csName, csMessage) csName, |
#define | XN_STATUS_MESSAGE_MAP_END_FROM(group, first) }; |
#define | XN_STATUS_MESSAGE_MAP_END(group) XN_STATUS_MESSAGE_MAP_END_FROM(group, 0) |
Typedefs |
typedef XnUInt32 | XnStatus |
typedef enum XnErrorGroup | XnErrorGroup |
Enumerations |
enum | XnErrorGroup { XN_ERROR_GROUP_NI = 1,
XN_ERROR_GROUP_OS = 2,
XN_ERROR_GROUP_PRIMESENSE = 3
} |
Functions |
XN_C_API const XnChar * | xnGetStatusString (const XnStatus Status) |
XN_C_API const XnChar * | xnGetStatusName (const XnStatus Status) |
XN_C_API void | xnPrintError (const XnStatus Status, const XnChar *csUserMessage) |
Define Documentation
#define XN_STATUS_CODE |
( |
|
status | ) |
(status & 0x0000FFFF) |
Returns the code of the status.
#define XN_STATUS_GROUP |
( |
|
status | ) |
(status >> 16) |
Returns the group of the status.
#define XN_STATUS_MAKE |
( |
|
group, |
|
|
|
code |
|
) |
| ((group << 16) | code) |
Constructs a status code from a module and an error code.
#define XN_STATUS_MESSAGE |
( |
|
csName, |
|
|
|
csMessage |
|
) |
| csName, |
Adds an entry to the message map.
#define XN_STATUS_MESSAGE_MAP_END |
( |
|
group | ) |
XN_STATUS_MESSAGE_MAP_END_FROM(group, 0) |
#define XN_STATUS_MESSAGE_MAP_END_FROM |
( |
|
group, |
|
|
|
first |
|
) |
| }; |
Marks the end of a message map.
#define XN_STATUS_MESSAGE_MAP_START |
( |
|
group | ) |
XN_STATUS_MESSAGE_MAP_START_FROM(group, 0) |
#define XN_STATUS_MESSAGE_MAP_START_FROM |
( |
|
group, |
|
|
|
first |
|
) |
| |
Value:enum _##group##first##Errors \
{ \
group##first##_OK = XN_STATUS_MAKE(group, first),
Marks the beginning of a message map of a specific module.
Typedef Documentation
A list of modules for Xiron status.
Defines the XnStatus type. The high word represents the group to which this error belongs to. The low word is a sequential number inside the group.
Enumeration Type Documentation
A list of modules for Xiron status.
- Enumerator:
XN_ERROR_GROUP_NI |
|
XN_ERROR_GROUP_OS |
|
XN_ERROR_GROUP_PRIMESENSE |
|
Function Documentation
XN_C_API const XnChar* xnGetStatusName |
( |
const XnStatus |
Status | ) |
|
Gets the name of a Xiron Status as a string.
- Parameters:
-
Status | [in] The input Xiron Status. |
- Returns:
- A string representation of the Xiron status name.
XN_C_API const XnChar* xnGetStatusString |
( |
const XnStatus |
Status | ) |
|
Converts a Xiron Status enumerator into a meaningful error string.
- Parameters:
-
Status | [in] The input Xiron Status to be converted to a string. |
- Returns:
- A string representation of the Xiron status.
XN_C_API void xnPrintError |
( |
const XnStatus |
Status, |
|
|
const XnChar * |
csUserMessage |
|
) |
| |
Prints a user message with a description of the error.
- Parameters:
-
Status | [in] The input Xiron Status. |
csUserMessage | [in] A user message. |