#include "XnStatusCodes.h"

Include dependency graph for XnMacros.h:

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

Defines
#define	XN_CHECK_INPUT_OVERFLOW(x, y)
#define	XN_CHECK_OUTPUT_OVERFLOW(x, y)
#define	XN_GOCLEANUP_RET(x, y)
#define	XN_IS_BOOL_OK_GOCLEANUP_RET(x, y)
#define	XN_IS_BOOL_OK_RET(x, y)
#define	XN_IS_STATUS_OK(x) XN_IS_STATUS_OK_RET(x, x)
#define	XN_IS_STATUS_OK_ASSERT(x)
#define	XN_IS_STATUS_OK_GOCLEANUP(x)
#define	XN_IS_STATUS_OK_GOCLEANUP_RET(x, y)
#define	XN_IS_STATUS_OK_RET(x, y)
#define	XN_RET_IF_NULL(x, y)
#define	XN_SETBITMASK(x) (1 << x-1)
#define	XN_VALIDATE_PTR(x, y)

Define Documentation

#define XN_CHECK_INPUT_OVERFLOW	(	x,
		y
	)

Value:

if (x > y)                                                                              \
                {                                                                                               \
                        return (XN_STATUS_INPUT_BUFFER_OVERFLOW);       \
                }

Returns an output overflow error if x is beyond y

Definition at line 109 of file XnMacros.h.

#define XN_CHECK_OUTPUT_OVERFLOW	(	x,
		y
	)

Value:

if (x > y)                                                                              \
                {                                                                                               \
                        return (XN_STATUS_OUTPUT_BUFFER_OVERFLOW);      \
                }

Returns an input overflow error if x is beyond y

Definition at line 116 of file XnMacros.h.

#define XN_GOCLEANUP_RET	(	x,
		y
	)

Value:

x = y;                                  \
                goto ErrorCleanUp;

Jumps to the ErrorCleanUp label if X isn't XN_STATUS_OK and returns Y.

Definition at line 97 of file XnMacros.h.

#define XN_IS_BOOL_OK_GOCLEANUP_RET	(	x,
		y
	)

Value:

if (x != TRUE)                                          \
                {                                                                       \
                        goto ErrorCleanUp;                              \
                }

Jumps to the ErrorCleanUp label if X isn't XN_STATUS_OK and returns Y.

Definition at line 90 of file XnMacros.h.

#define XN_IS_BOOL_OK_RET	(	x,
		y
	)

Value:

if (x != TRUE)                          \
                {                                                       \
                        return (y);                             \
                }

Returns Y if X isn't XN_STATUS_OK.

Definition at line 83 of file XnMacros.h.

#define XN_IS_STATUS_OK ( x ) XN_IS_STATUS_OK_RET(x, x)

Returns X if X isn't XN_STATUS_OK.

Definition at line 64 of file XnMacros.h.

#define XN_IS_STATUS_OK_ASSERT ( x )

Value:

if (x != XN_STATUS_OK)          \
        {                                                       \
                XN_ASSERT(FALSE);               \
                return (x);                             \
        }

Definition at line 67 of file XnMacros.h.

#define XN_IS_STATUS_OK_GOCLEANUP ( x )

Value:

if (x != XN_STATUS_OK)                  \
                {                                                               \
                        goto ErrorCleanUp;                      \
                }

Jumps to the ErrorCleanUp label if X isn't XN_STATUS_OK.

Definition at line 76 of file XnMacros.h.

#define XN_IS_STATUS_OK_GOCLEANUP_RET	(	x,
		y
	)

Value:

if (x != XN_STATUS_OK)                          \
                {                                                                       \
                        x = y;                                                  \
                        goto ErrorCleanUp;                              \
                }

Jumps to the ErrorCleanUp label if X isn't XN_STATUS_OK and return Y.

Definition at line 56 of file XnMacros.h.

#define XN_IS_STATUS_OK_RET	(	x,
		y
	)

Value:

if (x != XN_STATUS_OK)          \
                {                                                       \
                        return (y);                             \
                }

Returns Y if X isn't XN_STATUS_OK.

Definition at line 49 of file XnMacros.h.

#define XN_RET_IF_NULL	(	x,
		y
	)

Value:

if (x == NULL)                  \
                {                                               \
                        return (y);                     \
                }

Returns Y if X is NULL.

Definition at line 42 of file XnMacros.h.

#define XN_SETBITMASK ( x ) (1 << x-1)

Returns the (x)th power of 2.

Definition at line 39 of file XnMacros.h.

#define XN_VALIDATE_PTR	(	x,
		y
	)

Value:

if (x == NULL)                  \
                {                                               \
                        return (y);                     \
                }

Returns Y if X is null.

Definition at line 102 of file XnMacros.h.

Defines

Define Documentation