WdfUsbTargetDeviceRetrieveCurrentFrameNumber method
[Applies to KMDF only]
The WdfUsbTargetDeviceRetrieveCurrentFrameNumber method retrieves the current USB frame number.
Syntax
NTSTATUS WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
[in] WDFUSBDEVICE UsbDevice,
[out] PULONG CurrentFrameNumber
);
Parameters
- UsbDevice [in]
-
A handle to a USB device object that was obtained from a previous call to WdfUsbTargetDeviceCreateWithParameters.
- CurrentFrameNumber [out]
-
A pointer to a location that receives the current 32-bit USB frame number.
Return value
WdfUsbTargetDeviceRetrieveCurrentFrameNumber returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method can return one of the following values:
| Return code | Description |
|---|---|
|
An invalid parameter was detected. |
|
The frame number was unavailable, possibly because lower drivers do not provide frame numbers. |
This method also might return other NTSTATUS values.
A bug check occurs if the driver supplies an invalid object handle.
Remarks
For more information about the WdfUsbTargetDeviceRetrieveCurrentFrameNumber method and USB I/O targets, see USB I/O Targets.
Examples
The following code example calls WdfUsbTargetDeviceRetrieveCurrentFrameNumber. The example obtains a USB device object handle from driver-defined context space.
ULONG frameNumber;
PMY_DEVICE_CONTEXT pMyDeviceContext;
pMyDeviceContext = GetDeviceContext(Device);
status = WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
pMyDeviceContext->UsbTargetDevice,
&frameNumber
);
Requirements
|
Minimum KMDF version | 1.0 |
|---|---|
|
Header |
|
|
Library |
|
|
IRQL | <=DISPATCH_LEVEL |
|
DDI compliance rules | DriverCreate, KmdfIrql, KmdfIrql2, UsbKmdfIrql, UsbKmdfIrql2 |
See also
