#include "XnPlatform.h"
Go to the source code of this file.
Defines | |
#define | XN_STATUS_CODE(status) (status & 0x0000FFFF) |
#define | XN_STATUS_GROUP(status) (status >> 16) |
#define | XN_STATUS_MAKE(group, code) ((group << 16) | code) |
#define | XN_STATUS_MESSAGE(csName, csMessage) csName, |
#define | XN_STATUS_MESSAGE_MAP_END(group) XN_STATUS_MESSAGE_MAP_END_FROM(group, 0) |
#define | XN_STATUS_MESSAGE_MAP_END_FROM(group, first) }; |
#define | XN_STATUS_MESSAGE_MAP_START(group) XN_STATUS_MESSAGE_MAP_START_FROM(group, 0) |
#define | XN_STATUS_MESSAGE_MAP_START_FROM(group, first) |
Typedefs | |
typedef enum XnErrorGroup | XnErrorGroup |
typedef XnUInt32 | XnStatus |
Enumerations | |
enum | XnErrorGroup { XN_ERROR_GROUP_NI = 1, XN_ERROR_GROUP_OS = 2, XN_ERROR_GROUP_PRIMESENSE = 3 } |
Functions | |
XN_C_API const XnChar * | xnGetStatusName (const XnStatus Status) |
XN_C_API const XnChar * | xnGetStatusString (const XnStatus Status) |
XN_C_API void | xnPrintError (const XnStatus Status, const XnChar *csUserMessage) |
Variables | |
static const XnStatus | XN_STATUS_OK = 0 |
#define XN_STATUS_CODE | ( | status | ) | (status & 0x0000FFFF) |
Returns the code of the status.
Definition at line 92 of file XnStatus.h.
#define XN_STATUS_GROUP | ( | status | ) | (status >> 16) |
Returns the group of the status.
Definition at line 89 of file XnStatus.h.
#define XN_STATUS_MAKE | ( | group, | |
code | |||
) | ((group << 16) | code) |
Constructs a status code from a module and an error code.
Definition at line 86 of file XnStatus.h.
#define XN_STATUS_MESSAGE | ( | csName, | |
csMessage | |||
) | csName, |
Adds an entry to the message map.
Definition at line 104 of file XnStatus.h.
#define XN_STATUS_MESSAGE_MAP_END | ( | group | ) | XN_STATUS_MESSAGE_MAP_END_FROM(group, 0) |
Definition at line 111 of file XnStatus.h.
#define XN_STATUS_MESSAGE_MAP_END_FROM | ( | group, | |
first | |||
) | }; |
Marks the end of a message map.
Definition at line 108 of file XnStatus.h.
#define XN_STATUS_MESSAGE_MAP_START | ( | group | ) | XN_STATUS_MESSAGE_MAP_START_FROM(group, 0) |
Definition at line 100 of file XnStatus.h.
#define XN_STATUS_MESSAGE_MAP_START_FROM | ( | group, | |
first | |||
) |
Marks the beginning of a message map of a specific module.
Definition at line 95 of file XnStatus.h.
typedef enum XnErrorGroup XnErrorGroup |
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.
Definition at line 38 of file XnStatus.h.
enum XnErrorGroup |
A list of modules for Xiron status.
Definition at line 78 of file XnStatus.h.
XN_C_API const XnChar* xnGetStatusName | ( | const XnStatus | Status | ) |
Gets the name of a Xiron Status as a string.
Status | [in] The input Xiron Status. |
XN_C_API const XnChar* xnGetStatusString | ( | const XnStatus | Status | ) |
Converts a Xiron Status enumerator into a meaningful error string.
Status | [in] The input Xiron Status to be converted to a string. |
XN_C_API void xnPrintError | ( | const XnStatus | Status, |
const XnChar * | csUserMessage | ||
) |
Prints a user message with a description of the error.
Status | [in] The input Xiron Status. |
csUserMessage | [in] A user message. |
const XnStatus XN_STATUS_OK = 0 [static] |
Definition of the OK error code.
Definition at line 41 of file XnStatus.h.