OpenNI 1.5.4

Functions

XN_C_API XnStatus XN_C_DECL xnGetNodeErrorState (XnNodeHandle hInstance)
 
XN_C_API XnStatus XN_C_DECL xnRegisterToNodeErrorStateChange (XnNodeHandle hInstance, XnStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback)
 
XN_C_API void XN_C_DECL xnUnregisterFromNodeErrorStateChange (XnNodeHandle hInstance, XnCallbackHandle hCallback)
 

Detailed Description

The error state of a node is represented using XnStatus. A value of XN_STATUS_OK means the node is OK. Any other value represents some sort of error situation in the node.

Function Documentation

◆ xnGetNodeErrorState()

XN_C_API XnStatus XN_C_DECL xnGetNodeErrorState ( XnNodeHandle  hInstance)

Gets current error state of this node.

Parameters
hInstance[in] A handle to the instance.
Returns
The error state of this node.

◆ xnRegisterToNodeErrorStateChange()

XN_C_API XnStatus XN_C_DECL xnRegisterToNodeErrorStateChange ( XnNodeHandle  hInstance,
XnStateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle phCallback 
)

Registers a callback function to error state changes.

Parameters
hInstance[in] A handle to the instance.
handler[in] A pointer to a function that will be called when error state changes.
pCookie[in] A user cookie that will be passed to the callback function.
phCallback[out] Optional. Will be filled with a handle to be passed to xnUnregisterFromNodeErrorStateChange().

◆ xnUnregisterFromNodeErrorStateChange()

XN_C_API void XN_C_DECL xnUnregisterFromNodeErrorStateChange ( XnNodeHandle  hInstance,
XnCallbackHandle  hCallback 
)

Unregisters a callback function which was registered using xnRegisterToNodeErrorStateChange().

Parameters
hInstance[in] A handle to the instance.
hCallback[in] The handle to the callback returned from xnRegisterToNodeErrorStateChange().