 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function changes the USB frame length.
BOOL SetFrameLength( USB_HANDLE hDevice , HANDLE hEvent , USHORT uFrameLength );
Parameters
- hDevice
- [IN] Handle to a USB device.
- hEvent
- [IN] Handle to an event to signal when the frame length reaches target value.
- uFrameLength
- [IN] Specifies the desired frame length.
Return Values
TRUE indicates success. FALSE indicates failure.
Remarks
This function should be used infrequently by client drivers because changing the USB frame length may affect other devices on the bus. The driver must obtain frame-control access by calling the TakeFrameLengthControlfunction before attempting to change the frame length. To enable devices to adjust to the new frame length, USB requires that frame-length changes be done gradually, over a period of frames, instead of abruptly jumping to the target frame length. The client driver passes in an event handle, which is signaled once the frame length has reached the target.
This function does not always set exactly the requested length.
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 2.10 and later Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
ReleaseFrameLengthControl, TakeFrameLengthControl
Last updated on Tuesday, July 13, 2004