libvcomm  1.0
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
Data Structures | Macros | Typedefs | Functions
hidapi.h File Reference
#include <wchar.h>
Include dependency graph for hidapi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  hid_device_info
 

Macros

#define HID_API_EXPORT
 
#define HID_API_CALL
 
#define HID_API_EXPORT_CALL   HID_API_EXPORT HID_API_CALL
 

Typedefs

typedef struct hid_device_ hid_device
 

Functions

int HID_API_EXPORT HID_API_CALL hid_init (void)
 Initialize the HIDAPI library. More...
 
int HID_API_EXPORT HID_API_CALL 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 *device, 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 *device, 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 *device, int nonblock)
 Set the device handle to be non-blocking. More...
 
int HID_API_EXPORT HID_API_CALL hid_send_feature_report (hid_device *device, 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 *device, 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 *device)
 Close a HID device. More...
 
int HID_API_EXPORT_CALL hid_get_manufacturer_string (hid_device *device, wchar_t *string, size_t maxlen)
 Get The Manufacturer String from a HID device. More...
 
int HID_API_EXPORT_CALL hid_get_product_string (hid_device *device, wchar_t *string, size_t maxlen)
 Get The Product String from a HID device. More...
 
int HID_API_EXPORT_CALL hid_get_serial_number_string (hid_device *device, wchar_t *string, size_t maxlen)
 Get The Serial Number String from a HID device. More...
 
int HID_API_EXPORT_CALL hid_get_indexed_string (hid_device *device, 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 *device)
 Get a string describing the last error which occurred. More...
 

Macro Definition Documentation

#define HID_API_CALL

API call macro

Definition at line 37 of file hidapi.h.

#define HID_API_EXPORT

API export macro

Definition at line 36 of file hidapi.h.

#define HID_API_EXPORT_CALL   HID_API_EXPORT HID_API_CALL

API export and call macro

Definition at line 40 of file hidapi.h.

Typedef Documentation

typedef struct hid_device_ hid_device

opaque hidapi structure

Definition at line 46 of file hidapi.h.