OpenNI 1.5.4: Device Identification Capability

OpenNI

Device Identification Capability

Functions

XN_C_API XnStatus XN_C_DECL xnGetDeviceName (XnNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)
XN_C_API XnStatus XN_C_DECL xnGetVendorSpecificData (XnNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)
XN_C_API XnStatus XN_C_DECL xnGetSerialNumber (XnNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)

Detailed Description

The Device Identification Capability (XN_CAPABILITY_DEVICE_IDENTIFICATION) allows to identify the device according to its name, to a vendor-specific string and its serial number.


Function Documentation

XN_C_API XnStatus XN_C_DECL xnGetDeviceName ( XnNodeHandle  hInstance,
XnChar *  strBuffer,
XnUInt32 *  pnBufferSize 
)

Gets the device name.

Parameters:
hInstance[in] A handle to the instance.
strBuffer[in] A buffer to accept the device name.
pnBufferSize[in/out] Size of the buffer.
Returns:
XN_STATUS_OK if succeeded, or XN_STATUS_OUTPUT_BUFFER_OVERFLOW if buffer is not sufficient. in such a case, the device name should be truncated to fit in the buffer, and pnBufferSize should be updated to the required size.
XN_C_API XnStatus XN_C_DECL xnGetSerialNumber ( XnNodeHandle  hInstance,
XnChar *  strBuffer,
XnUInt32 *  pnBufferSize 
)

Gets the serial number of the device.

Parameters:
hInstance[in] A handle to the instance.
strBuffer[in] A buffer to accept the string.
pnBufferSize[in/out] Size of the buffer.
Returns:
XN_STATUS_OK if succeeded, or XN_STATUS_OUTPUT_BUFFER_OVERFLOW if buffer is not sufficient. in such a case, the string should be truncated to fit in the buffer, and pnBufferSize should be updated to the required size.
XN_C_API XnStatus XN_C_DECL xnGetVendorSpecificData ( XnNodeHandle  hInstance,
XnChar *  strBuffer,
XnUInt32 *  pnBufferSize 
)

Gets a vendor-specific string.

Parameters:
hInstance[in] A handle to the instance.
strBuffer[in] A buffer to accept the string.
pnBufferSize[in/out] Size of the buffer.
Returns:
XN_STATUS_OK if succeeded, or XN_STATUS_OUTPUT_BUFFER_OVERFLOW if buffer is not sufficient. in such a case, the string should be truncated to fit in the buffer, and pnBufferSize should be updated to the required size.
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen 1.7.5.1