Expand Minimize

WdfUsbTargetDeviceIsConnectedSynchronous method

[Applies to KMDF only]

The WdfUsbTargetDeviceIsConnectedSynchronous method determines if the specified USB device is connected.

Syntax


NTSTATUS WdfUsbTargetDeviceIsConnectedSynchronous(
  [in]  WDFUSBDEVICE UsbDevice
);

Parameters

UsbDevice [in]

A handle to a USB device object that was obtained from a previous call to WdfUsbTargetDeviceCreateWithParameters.

Return value

WdfUsbTargetDeviceIsConnectedSynchronous returns the I/O target's completion status value if the operation succeeds. Otherwise, this method can return one of the following values:

Return codeDescription
STATUS_INVALID_PARAMETER

An invalid parameter was detected.

STATUS_INVALID_DEVICE_REQUEST

The caller's IRQL was invalid.

STATUS_DEVICE_NOT_CONNECTED or STATUS_DEVICE_DOES_NOT_EXIST

The device was not connected.

 

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 WdfUsbTargetDeviceIsConnectedSynchronous method and USB I/O targets, see USB I/O Targets.

Examples

The following code example determines if a specified USB device is connected.


NTSTATUS status;

status = WdfUsbTargetDeviceIsConnectedSynchronous(UsbDevice);

Requirements

Minimum KMDF version

1.0

Header

Wdfusb.h (include Wdfusb.h)

Library

Wdf01000.sys (see Framework Library Versioning.)

IRQL

PASSIVE_LEVEL

DDI compliance rules

DriverCreate, KmdfIrql, KmdfIrql2, UsbKmdfIrql, UsbKmdfIrql2

See also

WdfUsbTargetDeviceCreateWithParameters

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft