USB
Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version
22.2
22.3
22.4
22.5
23.0
23.1
23.2
23.3
23.4
23.5
24.0
24.1
The list of the topics,
classes,
interfaces,
controls,
modules,
global methods by category,
global methods by name,
screenshots,
licenses
and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
USB
Everything around USB including HID interfaces.
- Classes
- class HIDAPIDeviceInfoMBS
- class HIDAPIDeviceMBS
- class LibUSBConfigDescriptorMBS
- class LibUSBDeviceDescriptorMBS
- class LibUSBDeviceMBS
- method AttachKernelDriver(interfaceNumber as Integer)
- method BulkTransfer(endpoint as Integer, data as Ptr, Length as Integer, byref ActualLength as Integer, Timeout as Integer)
- method ClaimInterface(interfaceNumber as Integer)
- method ClearHalt(endpoint as Integer)
- method Close
- method ControlTransfer(requestType as Integer, Request as Integer, Value as Integer, Index as Integer, data as Ptr, Length as Integer, Timeout as Integer) as Integer
- method DetachKernelDriver(interfaceNumber as Integer)
- shared method Devices as LibUSBDeviceMBS()
- shared method ErrorName(ErrorCode as Integer) as String
- method GetActiveConfigDescriptor as LibUSBConfigDescriptorMBS
- method GetConfigDescriptor(Index as Integer) as LibUSBConfigDescriptorMBS
- method GetConfigDescriptorByValue(Value as Integer) as LibUSBConfigDescriptorMBS
- method GetConfiguration as Integer
- method GetDescriptor(descType as Integer, descIndex as Integer, data as Ptr, Length as Integer) as Integer
- method GetDeviceDescriptor as LibUSBDeviceDescriptorMBS
- method GetMaxISOPacketSize(EndPoint as Integer) as Integer
- method GetMaxPacketSize(EndPoint as Integer) as Integer
- method GetStringDescriptor(descIndex as Integer, LangID as Integer = 0) as String
- method GetStringDescriptor(descIndex as Integer, LangID as Integer = 0, data as Ptr, Length as Integer) as Integer
- method GetStringDescriptorAscii(descIndex as Integer) as String
- method GetStringDescriptorAscii(descIndex as Integer, data as Ptr, Length as Integer) as Integer
- shared method HasCapability(Capability as UInt32) as Boolean
- shared method Initialize as Integer
- method InterruptTransfer(endpoint as Integer, data as Ptr, Length as Integer, byref ActualLength as Integer, Timeout as Integer)
- method KernelDriverActive(interfaceNumber as Integer) as Boolean
- shared method LibraryLoaded as Boolean
- shared method LibraryLoadErrorMessage as String
- shared method LibVersion as LibUSBVersionMBS
- shared method LoadLibrary(file as folderitem) as boolean
- shared method LoadLibrary(path as string) as boolean
- method Open as Boolean
- shared method OpenDevice(VID as Integer, PID as Integer) as LibUSBDeviceMBS
- method ReleaseInterface(interfaceNumber as Integer)
- method Reset
- method SetConfiguration(configuration as Integer)
- shared method SetDebug(level as integer)
- method SetInterfaceAltSetting(interfaceNumber as Integer, alternateSetting as Integer)
- shared method Shutdown
- property BusNumber as Integer
- property DeviceAddress as Integer
- property DeviceHandle as Integer
- property DeviceSpeed as Integer
- property Handle as Integer
- property IsOpen as Boolean
- property Lasterror as Integer
- class LibUSBEndpointDescriptorMBS
- class LibUSBInterfaceDescriptorMBS
- class LibUSBInterfaceMBS
- class LibUSBISOPacketDescriptorMBS
- class LibUSBTransferMBS
- method Cancel as Integer
- method Constructor(ISOPackets as Integer = 0)
- method ControlTransferGetData as Ptr
- method ControlTransferGetSetup as Ptr
- method FillBulkStreamTransfer(Device as LibUSBDeviceMBS, EndPoint as Integer, StreamId as Integer, Buffer as MemoryBlock, Timeout as Integer)
- method FillBulkTransfer(Device as LibUSBDeviceMBS, EndPoint as Integer, Buffer as MemoryBlock, Timeout as Integer)
- method FillControlSetup(Buffer as MemoryBlock, RequestType as Integer, Request as Integer, Value as Integer, Index as Integer, Length as Integer)
- method FillControlTransfer(Device as LibUSBDeviceMBS, Buffer as MemoryBlock, Timeout as Integer)
- method FillInterruptTransfer(Device as LibUSBDeviceMBS, EndPoint as Integer, Buffer as MemoryBlock, Timeout as Integer)
- method FillISOTransfer(Device as LibUSBDeviceMBS, EndPoint as Integer, Buffer as MemoryBlock, NumISOPackets as Integer, Timeout as Integer)
- method ISOPacketBuffer(Index as Integer) as Ptr
- method ISOPacketDescriptor(index as Integer) as LibUSBISOPacketDescriptorMBS
- method SetISOPacketLengths(Length as UInt32)
- method Submit as Integer
- property ActualLength as Integer
- property Buffer as MemoryBlock
- property Device as LibUSBDeviceMBS
- property Endpoint as Integer
- property Flags as Integer
- property ISOPackets as Integer
- property Length as Integer
- property Status as Integer
- property Tag as Variant
- property Timeout as Integer
- property Type as Integer
- event Completed
- class LibUSBVersionMBS
- class LinuxHIDInterfaceMBS
- shared method Available as boolean
- method Close as Integer
- method DumpTreeToStderr as Integer
- method DumpTreeToStdout as Integer
- method ForceOpen(theInterface as Integer, Vendor as Integer, Product as Integer, retries as Integer) as Integer
- method GetInputReport(path() as Integer, data as memoryblock, offset as Integer, size as Integer) as Integer
- method InterruptRead(EndPoint as Integer, mem as memoryblock, size as Integer, timeout as Integer) as Integer
- method InterruptWrite(EndPoint as Integer, mem as memoryblock, size as Integer, timeout as Integer) as Integer
- shared method IsInitialised as boolean
- method IsOpen as boolean
- method Open(theInterface as Integer, Vendor as Integer, Product as Integer) as Integer
- method Reset
- shared method SetDebugLevel(level as Integer)
- shared method SetDebugOutputToStderr
- shared method SetDebugOutputToStdout
- method SetOutputReport(path() as Integer, data as memoryblock, offset as Integer, size as Integer) as Integer
- method SetOutputReport(path() as Integer, data as string) as Integer
- method WriteIdentificationToStderr as Integer
- method WriteIdentificationToStdout as Integer
- property Handle as Integer
- event MatchDevice(usbdev as LinuxUSBDeviceHandleMBS) as boolean
- class LinuxUSBBusMBS
- class LinuxUSBDeviceDescriptionMBS
- class LinuxUSBDeviceHandleMBS
- class LinuxUSBDeviceMBS
- class MacHIDMBS
- method Close
- method Connect
- method Disconnect
- method FindFirstDevice as boolean
- method FindNextDevice as boolean
- method HIDProperties as Variant
- method InstallCallback
- method Manufacturer as string
- method Product as string
- method ProductID as Integer
- method ReadMessage(ReportID as Integer, reportType as Integer, length as Integer) as string
- method ReadMessageMemory(ReportID as Integer, reportType as Integer, length as Integer) as memoryblock
- method SendMessage(data as string)
- method SendMessage(ReportID as Integer, reportType as Integer, data as string)
- method SendMessageMemory(data as memoryblock, offset as Integer, length as Integer)
- method SendMessageMemory(ReportID as Integer, reportType as Integer, data as memoryblock, offset as Integer, length as Integer)
- method SerialNumber as string
- method VendorID as Integer
- method VersionNumber as Integer
- property IOHIDDeviceInterface122Handle as Integer
- property IOHIDObjectIteratorHandle as Integer
- property IOObjectHandle as Integer
- property Lasterror as Integer
- property OnlyOneEventPerTick as Boolean
- property TimeOut as Integer
- event DeviceRemoved(result as Integer)
- event ReceivedData(data as string, size as Integer)
- class MacUSBDeviceMBS
- class MacUSBMBS
- class MacUSBNotificationMBS
- method Constructor(vendor as Integer = 0, product as Integer = 0)
- shared method GetUSBDeviceInfo(DeviceHandle as Integer, byref Vendor as string, byref Product as string, byref SerialNumber as string, byref Revision as Integer) as boolean
- shared method QueryBSDName(DeviceHandle as Integer) as string
- shared method Release(DeviceHandle as Integer)
- shared method Retain(DeviceHandle as Integer)
- property LastError as Integer
- event DeviceAdded(properties as dictionary, NewDevice as boolean, ClassName as string, DeviceName as string, DeviceHandle as Integer)
- event DeviceRemoved(properties as dictionary, NewDevice as boolean, ClassName as string, DeviceName as string, DeviceHandle as Integer)
- class WinHIDMBS
- class WinUSBDeviceMBS
- class WinUSBInterfaceDescriptionMBS
- class WinUSBMBS
- method AbortPipe(PipeID as Integer)
- shared method Available as boolean
- method Constructor(path as string)
- method ControlTransfer(SetupPacket as WinUSBSetupPacketMBS, Buffer as MemoryBlock) as Integer
- method ControlTransfer(SetupPacket as WinUSBSetupPacketMBS, Buffer as String) as Integer
- method DeviceSpeed as Integer
- method FlushPipe(PipeID as Integer)
- method GetAssociatedInterface(index as Integer) as WinUSBMBS
- method QueryInterfaceSettings(index as Integer) as WinUSBInterfaceDescriptionMBS
- method QueryPipe(AlternateInterfaceNumber as Integer, PipeIndex as Integer) as WinUSBPipeInformationMBS
- method ReadPipeMemory(PipeID as Integer, BufferLength as Integer) as Memoryblock
- method ReadPipePacket(PipeID as Integer, MaxSize as Integer = 1024) as Memoryblock
- method ReadPipeString(PipeID as Integer, BufferLength as Integer) as string
- method ResetPipe(PipeID as Integer)
- method WritePipe(PipeID as Integer, Buffer as MemoryBlock) as Integer
- method WritePipe(PipeID as Integer, Buffer as String) as Integer
- method WritePipePacket(PipeID as Integer, Buffer as MemoryBlock) as Integer
- method WritePipePacket(PipeID as Integer, Buffer as String) as Integer
- property DeviceHandle as Integer
- property Lasterror as Integer
- property LasterrorMessage as String
- property Parent as WinUSBMBS
- property Tag as Variant
- property USBHandle as Integer
- property CurrentAlternateSetting as Integer
- property PipePolicyAllowPartialReads(PipeID as Integer) as boolean
- property PipePolicyAutoClearStall(PipeID as Integer) as boolean
- property PipePolicyAutoFlush(PipeID as Integer) as boolean
- property PipePolicyIgnoreShortPackets(PipeID as Integer) as boolean
- property PipePolicyMaximumTransferSize(PipeID as Integer) as Integer
- property PipePolicyPipeTransferTimeout(PipeID as Integer) as UInt32
- property PipePolicyRawIO(PipeID as Integer) as boolean
- property PipePolicyResetPipeOnResume(PipeID as Integer) as boolean
- property PipePolicyShortPacketTerminate(PipeID as Integer) as boolean
- class WinUSBNotificationMBS
- class WinUSBPipeInformationMBS
- class WinUSBSetupPacketMBS
- Blog Entries
Release notes
- Version 24.1
- Version 21.2
- Version 21.0
- Version 19.1
- Version 18.1
- Added LibUSBDeviceMBS and related classes to use LibUSB for cross platform USB functions.
The items on this page are in the following plugins: MBS USB Plugin.