3.2.4.11 USB_HOST_DeviceIsSuspended Function

C

USB_HOST_RESULT USB_HOST_DeviceIsSuspended(
    USB_HOST_DEVICE_OBJ_HANDLE deviceObjHandle
);

Summary

This function returns the suspend state of the specified USB device. This function can be used to check the completion of the Resume operation started by using the USB_HOST_Resume() function. If the Resume signaling has completed, the USB_HOST_IsSuspended() function would return USB_HOST_RESULT_TRUE.

Precondition

The USB_HOST_BusEnable() function should have been called.

Parameters

Returns

USB_HOST_RESULT_TRUE - if the device is suspended.

USB_HOST_RESULT_FALSE - if the device is not suspended.

USB_HOST_RESULT_DEVICE_UNKNOWN - the specified device does not exist in the system.

USB_HOST_RESULT_FAILURE - An unknown failure occurred.

Remarks

None.