Instance Property

GetBandwidthAvailableForDevice

Returns the amount of bandwidth available on the bus for allocation to periodic pipes. If the device is a high or super speed device, it will be the number of bytes per microframe (125 µsecs). If it is a full speed device, it will be the number of bytes per frame (1ms)

Declaration

IOReturn (*GetBandwidthAvailableForDevice)(void *self, UInt32 *bandwidth);

Parameters

self

Pointer to the IOUSBInterfaceInterface.

bandwidth

Pointer to UInt32 to hold the amount of bandwidth available (in bytes per frame or microframe).

Return Value

Returns kIOReturnSuccess if successful, kIOReturnNoDevice if there is no connection to an IOService.

Discussion

This function is useful for determining the correct AltInterface setting as well as for using SetPipePolicy. The interface does not have to be open to use this function.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software