Platforms to show: All Mac Windows Linux Cross-Platform
Back to LinuxHIDInterfaceMBS class.
LinuxHIDInterfaceMBS.Close as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.DumpTreeToStderr as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
Some examples using this method:
LinuxHIDInterfaceMBS.DumpTreeToStdout as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.ForceOpen(theInterface as Integer, Vendor as Integer, Product as Integer, retries as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Vendor or Product code can be kMatchAny (0) to match all devices.
You can use the MatchDevice event to learn which devices are there and return true there to select one.
Returns error code. See kError* constants.
Some examples using this method:
LinuxHIDInterfaceMBS.GetInputReport(path() as Integer, data as memoryblock, offset as Integer, size as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Path: The path to the endpoint.
Data: the memoryblock to store the data.
Offset: The offset where to start inside the memoryblock.
Size: the length of the data int he memoryblock.
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.InterruptRead(EndPoint as Integer, mem as memoryblock, size as Integer, timeout as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
EndPoint: The index of the endpoint.
mem: the memoryblock where to store the data.
size: the length of the data block to read.
timeout: the timeout in milliseconds.
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.InterruptWrite(EndPoint as Integer, mem as memoryblock, size as Integer, timeout as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 11.0 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
EndPoint: The index of the endpoint.
mem: the memoryblock where to store the data.
size: the length of the data block to read.
timeout: the timeout in milliseconds.
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.IsOpen as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
True if open, false if closed.
LinuxHIDInterfaceMBS.Open(theInterface as Integer, Vendor as Integer, Product as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Vendor or Product code can be kMatchAny (0) to match all devices.
You can use the MatchDevice event to learn which devices are there and return true there to select one.
Returns error code. See kError* constants.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.SetOutputReport(path() as Integer, data as memoryblock, offset as Integer, size as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Path: The path to the endpoint.
Data: the data to write.
Offset: The offset where to start inside the memoryblock.
Size: the length of the data int he memoryblock.
Returns error code. See kError* constants.
See also:
LinuxHIDInterfaceMBS.SetOutputReport(path() as Integer, data as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Path: The path to the endpoint.
Data: the data to write.
Returns error code. See kError* constants.
See also:
LinuxHIDInterfaceMBS.WriteIdentificationToStderr as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
LinuxHIDInterfaceMBS.WriteIdentificationToStdout as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | USB | MBS USB Plugin | 10.3 | ❌ No | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns error code. See kError* constants.
The items on this page are in the following plugins: MBS USB Plugin.