XnStatusRegister.h File Reference

#include "XnStatus.h"

Include dependency graph for XnStatusRegister.h:

Go to the source code of this file.

Classes
struct	XnErrorCodeData
Defines
#define	_XN_ERROR_GROUP_NAME(group, first)   _s_##group##first##_errors
#define	XN_STATUS_MESSAGE(csName, csMessage)   { 0, XN_STRINGIFY(csName), csMessage },
#define	XN_STATUS_MESSAGE_MAP_END_FROM(group, first)
#define	XN_STATUS_MESSAGE_MAP_START_FROM(group, first)
#define	XN_STATUS_REGISTER
Typedefs
typedef struct XnErrorCodeData	XnErrorCodeData
Functions
XN_C_API XnStatus	xnRegisterErrorCodeMessages (XnUInt16 nGroup, XnUInt16 nFirst, XnUInt16 nCount, XnErrorCodeData *pErrorCodeData)

---

Define Documentation

#define _XN_ERROR_GROUP_NAME	(		group,
			first
	)		_s_##group##first##_errors

Definition at line 67 of file XnStatusRegister.h.

#define XN_STATUS_MESSAGE	(		csName,
			csMessage
	)		{ 0, XN_STRINGIFY(csName), csMessage },

Adds an entry to the message map.

Definition at line 75 of file XnStatusRegister.h.

#define XN_STATUS_MESSAGE_MAP_END_FROM	(		group,
			first
	)

Value:

};                                                                                                      \
        static XnStatus s_##group##first##_result = xnRegisterErrorCodeMessages(group, first, sizeof(_XN_ERROR_GROUP_NAME(group, first)) / sizeof(XnErrorCodeData), _XN_ERROR_GROUP_NAME(group, first));

Marks the end of a message map.

Definition at line 79 of file XnStatusRegister.h.

#define XN_STATUS_MESSAGE_MAP_START_FROM	(		group,
			first
	)

Value:

static XnErrorCodeData _XN_ERROR_GROUP_NAME(group, first)[] =           \
        {                                                                                                                                       \
                { first, XN_STRINGIFY(group) "_OK", XN_STRINGIFY(group) " OK" },

Definition at line 69 of file XnStatusRegister.h.

#define XN_STATUS_REGISTER

Definition at line 83 of file XnStatusRegister.h.

---

Typedef Documentation

typedef struct XnErrorCodeData XnErrorCodeData

---

Function Documentation

XN_C_API XnStatus xnRegisterErrorCodeMessages	(	XnUInt16	nGroup,
		XnUInt16	nFirst,
		XnUInt16	nCount,
		XnErrorCodeData *	pErrorCodeData
	)

This function registers error codes to the message map.

Parameters:

nGroup	[in] The group for which these errors belong to.
nFirst	[in] The first value.
nCount	[in] The number of status messages to register.
pErrorCodeData	[in] An array of status messages.