OpenNI 1.5.4: XnModuleLockAwareInterface Struct Reference

OpenNI

XnModuleLockAwareInterface Struct Reference

#include <XnModuleInterface.h>

List of all members.

Public Attributes

XnStatus(* SetLockState )(XnModuleNodeHandle hInstance, XnBool bLocked)
XnBool(* GetLockState )(XnModuleNodeHandle hInstance)
XnStatus(* RegisterToLockChange )(XnModuleNodeHandle hInstance, XnModuleStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback)
void(* UnregisterFromLockChange )(XnModuleNodeHandle hInstance, XnCallbackHandle hCallback)

Member Data Documentation

Gets current lock state.

Parameters:
hInstance[in] A handle to the instance.

Registers a callback function to lock changes.

Parameters:
hInstance[in] A handle to the instance.
handler[in] A pointer to a function that will be called when lock 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 UnregisterFromLockChange().

Notifies the node its lock state was changed.

Parameters:
hInstance[in] A handle to the instance.
bLocked[in] Current lock state.

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

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

The documentation for this struct was generated from the following file:
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen 1.7.5.1