UdecxUsbDevicePlugIn function (udecxusbdevice.h)

Article
02/22/2024

Notifies the USB device emulation class extension (UdeCx) that the USB device has been plugged in the specified port.

Syntax

NTSTATUS UdecxUsbDevicePlugIn(
  [in] UDECXUSBDEVICE                    UdecxUsbDevice,
  [in] PUDECX_USB_DEVICE_PLUG_IN_OPTIONS Options
);

Parameters

[in] UdecxUsbDevice

A handle to UDE device object. The client driver retrieved this pointer in the previous call to UdecxUsbDeviceCreate.

[in] Options

A UDECX_USB_DEVICE_PLUG_IN_OPTIONS-type value that indicates the port to which the device is plugged. At most one of Usb20PortNumber, Usb30PortNumber can be non-zero. NULL disables plug-in options (use defaults).

Return value

The method returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method might return an appropriate NTSTATUS error code.

Remarks

After the client driver calls this method, the class extension sends I/O requests and invokes callback functions on the endpoints and the device.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Minimum KMDF version	1.15
Header	udecxusbdevice.h (include Udecx.h)
Library	Udecxstub.lib
IRQL	PASSIVE_LEVEL