GetStatus (Compact 2013)
3/26/2014
This function sends a GET_STATUS request to a universal serial bus (USB) device.
Syntax
DWORD GetStatus(
LPCUSB_FUNCS pUsbFuncs,
HANDLE hUsbDevice,
LPTRANSFER_NOTIFY_ROUTINE NotifyRoutine,
PVOID NotifyContext,
DWORD dwFlags,
UCHAR bIndex,
LPWORD lpwStatus,
DWORD dwTimeout
);
Parameters
- pUsbFuncs
[in] Pointer to a USB_FUNCS structure.
- hUsbDevice
[in] Handle to a USB device.
- NotifyRoutine
[in] Pointer to a callback function to signal a completion event. This is of type LPTRANSFER_NOTIFY_ROUTINE, which might be NULL.
- NotifyContext
[in] Handle to a BulkXXX completion event.
dwFlags
[in] Value of USB_NO_WAIT or zero (0), and one of the values from the following table.Value
Description
USB_SEND_TO_DEVICE
Request for status of the device.
USB_SEND_TO_INTERFACE
Request for status of the interface.
USB_SEND_TO_ENDPOINT
Request for status of the endpoint.
- bIndex
[in] Value of zero (0) for DEVICE, or interface or endpoint number.
- lpwStatus
[out] Device's status.
- dwTimeout
[in] Timeout in milliseconds (ms).
Return Value
TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError.
Remarks
This function initiates a control transfer to a USB device requesting device, interface, or endpoint status.
Synchronous calls to GetStatus can negatively affect performance.
Requirements
Header |
usbclient.h |
See Also
Reference
USB Host Client Driver Functions
AbortTransfer
GetTransferStatus
LPIS_TRANSFER_COMPLETE
LPTRANSFER_NOTIFY_ROUTINE
USB_FUNCS