WdfIoTargetGetState function

[Applies to KMDF and UMDF]

The WdfIoTargetGetState method returns state information for a local or remote I/O target.

Syntax

WDF_IO_TARGET_STATE WdfIoTargetGetState(
  _In_ WDFIOTARGET IoTarget
);

Parameters

IoTarget

A handle to a local or remote I/O target object that was obtained from a previous call to WdfDeviceGetIoTarget or WdfIoTargetCreate or from a method that a specialized I/O target supplies.

Return Value

WdfIoTargetGetState returns a WDF_IO_TARGET_STATE-typed value that indicates the state of the specified I/O target.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about WdfIoTargetGetState, see Controlling a General I/O Target's State.

For more information about I/O targets, see Using I/O Targets.

Examples

The following code example obtains state information for a USB I/O target.

WDF_IO_TARGET_STATE  ioTargetState;

ioTargetState = WdfIoTargetGetState(WdfUsbTargetPipeGetIoTarget(pipeHandle));

Requirements

   
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfiotarget.h (include Wdf.h)
Library Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL "<=DISPATCH_LEVEL"
DDI compliance rules DriverCreate, KmdfIrql, KmdfIrql2

See Also

WdfDeviceGetIoTarget

WDF_IO_TARGET_STATE

WdfIoTargetCreate

Send comments about this topic to Microsoft