Silicon Labs Host Libraries
HID Device Status Codes

Macros

#define HID_DEVICE_SUCCESS   0x00
 SILABS_STATUS no error More...
 
#define HID_DEVICE_NOT_FOUND   0x01
 Indicates that the specified device index was invalid or the device does not exist or is inaccessible. More...
 
#define HID_DEVICE_NOT_OPENED   0x02
 Indicates that the device must be opened prior to calling the function. More...
 
#define HID_DEVICE_ALREADY_OPENED   0x03
 Indicates that the device is already opened and cannot be re-opened. More...
 
#define HID_DEVICE_TRANSFER_TIMEOUT   0x04
 Indicates that a get or set report function returned due to a timeout. HidDevice_GetInputReport_Interrupt() and/or HidDevice_GetInputReport_Interrupt_WithTimeout() returned with less bytes than requested. More...
 
#define HID_DEVICE_TRANSFER_FAILED   0x05
 The host failed to communicate with the device or function parameters are incorrect. More...
 
#define HID_DEVICE_CANNOT_GET_HID_INFO   0x06
 Cannot retrieve device path or hidStringType is invalid. More...
 
#define HID_DEVICE_HANDLE_ERROR   0x07
 HID CreateFile() handle is invalid. More...
 
#define HID_DEVICE_INVALID_BUFFER_SIZE   0x08
 Specified buffer is not large enough to return requested data. More...
 
#define HID_DEVICE_SYSTEM_CODE   0x09
 Indicates that a system error occurred. Call Windows GetLastError() to retrieve the system error code. More...
 
#define HID_DEVICE_INVALID_PARAMETER   0x0B
 Specified (typically non-buffer related) parameter is wrong or unexpected. More...
 
#define HID_DEVICE_UNKNOWN_ERROR   SILABS_STATUS_UNKNOWN_ERROR
 This is the default return code value. This value should never be returned. More...
 
#define HID_DEVICE_UNSUPPORTED_FUNCTION   0x0A
 The function is only supported on certain (newer?) Windows versions. More...
 

Typedefs

typedef BYTE SLAB_HID_DEVICE_STATUS
 SLAB HID Device Status Codes. More...
 

Detailed Description

Macro Definition Documentation

◆ HID_DEVICE_ALREADY_OPENED

#define HID_DEVICE_ALREADY_OPENED   0x03

Indicates that the device is already opened and cannot be re-opened.

◆ HID_DEVICE_CANNOT_GET_HID_INFO

#define HID_DEVICE_CANNOT_GET_HID_INFO   0x06

Cannot retrieve device path or hidStringType is invalid.

◆ HID_DEVICE_HANDLE_ERROR

#define HID_DEVICE_HANDLE_ERROR   0x07

HID CreateFile() handle is invalid.

◆ HID_DEVICE_INVALID_BUFFER_SIZE

#define HID_DEVICE_INVALID_BUFFER_SIZE   0x08

Specified buffer is not large enough to return requested data.

◆ HID_DEVICE_INVALID_PARAMETER

#define HID_DEVICE_INVALID_PARAMETER   0x0B

Specified (typically non-buffer related) parameter is wrong or unexpected.

◆ HID_DEVICE_NOT_FOUND

#define HID_DEVICE_NOT_FOUND   0x01

Indicates that the specified device index was invalid or the device does not exist or is inaccessible.

◆ HID_DEVICE_NOT_OPENED

#define HID_DEVICE_NOT_OPENED   0x02

Indicates that the device must be opened prior to calling the function.

◆ HID_DEVICE_SUCCESS

#define HID_DEVICE_SUCCESS   0x00

SILABS_STATUS no error

◆ HID_DEVICE_SYSTEM_CODE

#define HID_DEVICE_SYSTEM_CODE   0x09

Indicates that a system error occurred. Call Windows GetLastError() to retrieve the system error code.

◆ HID_DEVICE_TRANSFER_FAILED

#define HID_DEVICE_TRANSFER_FAILED   0x05

The host failed to communicate with the device or function parameters are incorrect.

◆ HID_DEVICE_TRANSFER_TIMEOUT

#define HID_DEVICE_TRANSFER_TIMEOUT   0x04

Indicates that a get or set report function returned due to a timeout. HidDevice_GetInputReport_Interrupt() and/or HidDevice_GetInputReport_Interrupt_WithTimeout() returned with less bytes than requested.

◆ HID_DEVICE_UNKNOWN_ERROR

#define HID_DEVICE_UNKNOWN_ERROR   SILABS_STATUS_UNKNOWN_ERROR

This is the default return code value. This value should never be returned.

◆ HID_DEVICE_UNSUPPORTED_FUNCTION

#define HID_DEVICE_UNSUPPORTED_FUNCTION   0x0A

The function is only supported on certain (newer?) Windows versions.

Typedef Documentation

◆ SLAB_HID_DEVICE_STATUS

SLAB HID Device Status Codes.