AN249 Silicon_Laboratories, AN249 Datasheet - Page 23

• Manufacturer Part Number: AN249
• Description: Human Interface Device Tutorial
• Manufacturer: Silicon_Laboratories

6.6. SetFeatureReport()
Description:
Prototype:
Parameters:
Return Value:
6.7. GetFeatureReport()
Description:
Prototype:
Parameters:
Return Value:
6.8. SetReport_Interrupt()
Description:
Prototype:
Parameters:
Return Value:
Results = HID_DEVICE_SUCCESS or
This routine sends a feature report across the control pipe using the HID API function
HidD_GetFeatureReport().
BYTE SetFeatureReport(BYTE* buffer, DWORD bufferSize)
1. buffer - pointer to the feature report to be transmitted. This buffer must be able to
store at least bufferSize bytes.
2. bufferSize - size of the feature report in bytes.
This routine retrieves a feature report across the control pipe using the HID API
function HidD_GetFeatureReport().
BYTE GetFeatureReport(BYTE* buffer, DWORD bufferSize)
1. buffer - pointer to location where retrieved feature report will be stored. This
buffer must be able to store at least bufferSize bytes.
IMPORTANT NOTE: The first byte of this buffer should be the report ID of the
report to be retrieved.
2. bufferSize - should be set to the size of the largest feature report listed in the
device's report descriptor. This information can be obtained by calling the member
function GetFeatureReportBufferLength().
Results = HID_DEVICE_SUCCESS or
HID_DEVICE_TRANSFER_FAILED or
HID_DEVICE_NOT_OPENED
This function sends an OUT report across the interrupt pipe using a call to
WriteFile().
BYTE SetReport_Interrupt(BYTE* buffer, DWORD bufferSize)
1. buffer - pointer to the OUT report to be transmitted. This buffer must be able to
store at least bufferSize bytes.
2. bufferSize - size of the OUT report in bytes.
Results = HID_DEVICE_SUCCESS or
HID_DEVICE_TRANSFER_TIMEOUT or
HID_DEVICE_TRANSFER_FAILED or
HID_DEVICE_NOT_OPENED or
HID_DEVICE_INVALID_BUFFER_SIZE
HID_DEVICE_TRANSFER_FAILED or
HID_DEVICE_NOT_OPENED
Rev. 0.2
AN249
23