OpenNI 1.5.4: XnModuleDeviceIdentificationInterface Struct Reference

OpenNI

XnModuleDeviceIdentificationInterface Struct Reference

#include <XnModuleInterface.h>

List of all members.

Public Attributes

XnStatus(* GetDeviceName )(XnModuleNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)
XnStatus(* GetVendorSpecificData )(XnModuleNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)
XnStatus(* GetSerialNumber )(XnModuleNodeHandle hInstance, XnChar *strBuffer, XnUInt32 *pnBufferSize)

Member Data Documentation

XnStatus(* XnModuleDeviceIdentificationInterface::GetDeviceName)(XnModuleNodeHandle 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.
XnStatus(* XnModuleDeviceIdentificationInterface::GetSerialNumber)(XnModuleNodeHandle 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.
XnStatus(* XnModuleDeviceIdentificationInterface::GetVendorSpecificData)(XnModuleNodeHandle 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.

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