Platforms to show: All Mac Windows Linux Cross-Platform

Back to HIDAPIDeviceMBS class.

HIDAPIDeviceMBS.DeviceHandle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The device handle used.

For Windows a HANDLE to the open device, for Mac a IOHIDDeviceRef reference and Linux the handle from open function.
(Read only property)

HIDAPIDeviceMBS.DeviceInfo as HIDAPIDeviceInfoMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 24.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries the device info for this device.

Returns nil in case of errors.
(Read only property)

HIDAPIDeviceMBS.Error as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Get a string describing the last error which occurred.

This function returns a string containing the last error which occurred or "" if none has occurred.

This provides errors per device.
(Read only property)

HIDAPIDeviceMBS.FeatureReportLength as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.1 ✅ Yes ✅ Yes ❌ No ❌ No Desktop, Console & Web
The length of a feature report.

Not implemented for Linux.
Returns -1 if unknown.
On Mac this is more the maximum report length.
(Read only property)

HIDAPIDeviceMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The internal object reference.

(Read only property)

HIDAPIDeviceMBS.InputReportLength as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.1 ✅ Yes ✅ Yes ❌ No ❌ No Desktop, Console & Web
The length of an input report.

Not implemented for Linux.
Returns -1 if unknown.
On Mac this is more the maximum report length.
(Read only property)

HIDAPIDeviceMBS.ManufacturerString as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The Manufacturer String from a HID device.

(Read only property)

HIDAPIDeviceMBS.NonBlocking as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set the device handle to be non-blocking.

In non-blocking mode calls to Read() will return immediately with a value of 0 if there is no data to be read. In blocking mode, Read() will wait (block) until there is data to read before returning.
Nonblocking can be turned on and off at any time.

Value true: enable or not the nonblocking reads.
Value false: to disable nonblocking.
(Read and Write property)

Some examples using this property:

HIDAPIDeviceMBS.OutputReportLength as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.1 ✅ Yes ✅ Yes ❌ No ❌ No Desktop, Console & Web
The length of an output report.

Not implemented for Linux.
Returns -1 if unknown.
On Mac this is more the maximum report length.
(Read only property)

HIDAPIDeviceMBS.ProductString as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The Product String from a HID device.

(Read only property)

HIDAPIDeviceMBS.SerialNumber as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property USB MBS USB Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The Serial Number String from a HID device.

(Read only property)

The items on this page are in the following plugins: MBS USB Plugin.


The biggest plugin in space...