|
| typedef LONG | NTSTATUS |
| |
| typedef struct _HIDD_ATTRIBUTES | HIDD_ATTRIBUTES |
| |
| typedef struct _HIDD_ATTRIBUTES * | PHIDD_ATTRIBUTES |
| |
| typedef USHORT | USAGE |
| |
| typedef struct _HIDP_CAPS | HIDP_CAPS |
| |
| typedef struct _HIDP_CAPS * | PHIDP_CAPS |
| |
| typedef void * | PHIDP_PREPARSED_DATA |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetAttributes_) (HANDLE device, PHIDD_ATTRIBUTES attrib) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetSerialNumberString_) (HANDLE device, PVOID buffer, ULONG buffer_len) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetManufacturerString_) (HANDLE handle, PVOID buffer, ULONG buffer_len) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetProductString_) (HANDLE handle, PVOID buffer, ULONG buffer_len) |
| |
| typedef BOOLEAN(__stdcall * | HidD_SetFeature_) (HANDLE handle, PVOID data, ULONG length) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetFeature_) (HANDLE handle, PVOID data, ULONG length) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetIndexedString_) (HANDLE handle, ULONG string_index, PVOID buffer, ULONG buffer_len) |
| |
| typedef BOOLEAN(__stdcall * | HidD_GetPreparsedData_) (HANDLE handle, PHIDP_PREPARSED_DATA *preparsed_data) |
| |
| typedef BOOLEAN(__stdcall * | HidD_FreePreparsedData_) (PHIDP_PREPARSED_DATA preparsed_data) |
| |
| typedef NTSTATUS(__stdcall * | HidP_GetCaps_) (PHIDP_PREPARSED_DATA preparsed_data, HIDP_CAPS *caps) |
| |
|
| int HID_API_EXPORT | hid_init (void) |
| | Initialize the HIDAPI library. More...
|
| |
| int HID_API_EXPORT | hid_exit (void) |
| | Finalize the HIDAPI library. More...
|
| |
| struct hid_device_info HID_API_EXPORT *HID_API_CALL | hid_enumerate (unsigned short vendor_id, unsigned short product_id) |
| | Enumerate the HID Devices. More...
|
| |
| void HID_API_EXPORT HID_API_CALL | hid_free_enumeration (struct hid_device_info *devs) |
| | Free an enumeration Linked List. More...
|
| |
| HID_API_EXPORT hid_device *HID_API_CALL | hid_open (unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) |
| | Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally a serial number. More...
|
| |
| HID_API_EXPORT hid_device *HID_API_CALL | hid_open_path (const char *path) |
| | Open a HID device by its path name. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_write (hid_device *dev, const unsigned char *data, size_t length) |
| | Write an Output report to a HID device. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_read_timeout (hid_device *dev, unsigned char *data, size_t length, int milliseconds) |
| | Read an Input report from a HID device with timeout. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_read (hid_device *dev, unsigned char *data, size_t length) |
| | Read an Input report from a HID device. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_set_nonblocking (hid_device *dev, int nonblock) |
| | Set the device handle to be non-blocking. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_send_feature_report (hid_device *dev, const unsigned char *data, size_t length) |
| | Send a Feature report to the device. More...
|
| |
| int HID_API_EXPORT HID_API_CALL | hid_get_feature_report (hid_device *dev, unsigned char *data, size_t length) |
| | Get a feature report from a HID device. More...
|
| |
| void HID_API_EXPORT HID_API_CALL | hid_close (hid_device *dev) |
| | Close a HID device. More...
|
| |
| int HID_API_EXPORT_CALL HID_API_CALL | hid_get_manufacturer_string (hid_device *dev, wchar_t *string, size_t maxlen) |
| | Get The Manufacturer String from a HID device. More...
|
| |
| int HID_API_EXPORT_CALL HID_API_CALL | hid_get_product_string (hid_device *dev, wchar_t *string, size_t maxlen) |
| | Get The Product String from a HID device. More...
|
| |
| int HID_API_EXPORT_CALL HID_API_CALL | hid_get_serial_number_string (hid_device *dev, wchar_t *string, size_t maxlen) |
| | Get The Serial Number String from a HID device. More...
|
| |
| int HID_API_EXPORT_CALL HID_API_CALL | hid_get_indexed_string (hid_device *dev, int string_index, wchar_t *string, size_t maxlen) |
| | Get a string from a HID device, based on its string index. More...
|
| |
| HID_API_EXPORT const wchar_t *HID_API_CALL | hid_error (hid_device *dev) |
| | Get a string describing the last error which occurred. More...
|
| |
Get a feature report from a HID device.
Make sure to set the first byte of @p data[] to the Report
ID of the report to be read. Make sure to allow space for
this extra byte in @p data[].
@ingroup API
@param device A device handle returned from hid_open().
@param data A buffer to put the read data into, including
the Report ID. Set the first byte of @p data[] to the
Report ID of the report to be read.
@param length The number of bytes to read, including an
extra byte for the report ID. The buffer can be longer
than the actual report.
@returns
This function returns the number of bytes read and
-1 on error.
Definition at line 767 of file hid_win.c.
Initialize the HIDAPI library.
This function initializes the HIDAPI library. Calling it is not
strictly necessary, as it will be called automatically by
hid_enumerate() and any of the hid_open_*() functions if it is
needed. This function should be called at the beginning of
execution however, if there is a chance of HIDAPI handles
being opened by different threads simultaneously.
@ingroup API
@returns
This function returns 0 on success and -1 on error.
Definition at line 230 of file hid_win.c.
Send a Feature report to the device.
Feature reports are sent over the Control endpoint as a
Set_Report transfer. The first byte of @p data[] must
contain the Report ID. For devices which only support a
single report, this must be set to 0x0. The remaining bytes
contain the report data. Since the Report ID is mandatory,
calls to hid_send_feature_report() will always contain one
more byte than the report contains. For example, if a hid
report is 16 bytes long, 17 bytes must be passed to
hid_send_feature_report(): the Report ID (or 0x0, for
devices which do not use numbered reports), followed by the
report data (16 bytes). In this example, the length passed
in would be 17.
@ingroup API
@param device A device handle returned from hid_open().
@param data The data to send, including the report number as
the first byte.
@param length The length in bytes of the data to send, including
the report number.
@returns
This function returns the actual number of bytes written and
-1 on error.
Definition at line 755 of file hid_win.c.
Write an Output report to a HID device.
The first byte of @p data[] must contain the Report ID. For
devices which only support a single report, this must be set
to 0x0. The remaining bytes contain the report data. Since
the Report ID is mandatory, calls to hid_write() will always
contain one more byte than the report contains. For example,
if a hid report is 16 bytes long, 17 bytes must be passed to
hid_write(), the Report ID (or 0x0, for devices with a
single report), followed by the report data (16 bytes). In
this example, the length passed in would be 17.
hid_write() will send the data on the first OUT endpoint, if
one exists. If it does not, it will send the data through
the Control Endpoint (Endpoint 0).
@ingroup API
@param device A device handle returned from hid_open().
@param data The data to send, including the report number as
the first byte.
@param length The length in bytes of the data to send.
@returns
This function returns the actual number of bytes written and
-1 on error.
Definition at line 603 of file hid_win.c.
