DRV_DeviceGetProperty

INT32S DRV_DeviceGetProperty(
   PTR_T DeviceHandle,
   INT16U nPropertyID,
   VOID *pBuffer,
   INT32U * pLength );

Purpose

On the DeviceHandle specified device, it retrieves the device property by its pre-defined property ID.

Parameters

By specifying the property ID (nPropertyID) and defining the corresponding buffer (pBuffer) of property and the buffer length (pLength), the user can retrieve the required property information.

The property ID contains pre-defined constants that indicate properties. Therefore, the user can acquire the corresponding device property of the constant. Please refer to the Notes at the end of this page for details.

Name	Dircetion	Range	Description
DeviceHandle	input	default	The pointer retrieved from the DRV_DeviceOpen which specifies the target device.
nPropertyID	input	default	The pre-defined device property ID. It is used to retrieve the corresponding device properties. Please refer to the Notes for details.
pBuffer	input	default	The pointer to the buffer that receives the property setting value. This buffer should be allocated by the user.
pLength	input	default	The input buffer length of the pBuffer in bytes.

Return

1. 0	Successful.
2. Other Value	Please reference ErrorCodes .

Notes

1. For the definition of device property ID, please refer to the corresponding individual device driver manual for details.