EVT_UDECX_USB_ENDPOINT_RESET callback function (udecxusbendpoint.h)

Article
02/22/2024

The USB device emulation class extension (UdeCx) invokes this callback function to reset an endpoint of the virtual USB device.

Syntax

EVT_UDECX_USB_ENDPOINT_RESET EvtUdecxUsbEndpointReset;

void EvtUdecxUsbEndpointReset(
  [in] UDECXUSBENDPOINT UdecxUsbEndpoint,
  [in] WDFREQUEST Request
)
{...}

Parameters

[in] UdecxUsbEndpoint

A handle to a UDE endpoint object that represents the endpoint to reset. The client driver retrieved this pointer in the previous call to UdecxUsbEndpointCreate.

[in] Request

A handle to a framework request object that represents the request to reset the endpoint.

Return value

None

Remarks

The client driver registered this callback function in a previous call to UdecxUsbEndpointInitSetCallbacks by supplying a function pointer to its implementation.

The reset request clears the error condition in the endpoint that causes failed I/O transfers. At that time, UdeCx can invoke the EVT_UDECX_USB_ENDPOINT_RESET callback function. That call is asynchronous. The client driver completes the request and signals completion with status by calling WdfRequestCompleteWithInformation method . (this is the only way the UDECX client uses the request parameter).

Requirements

Requirement	Value
Minimum supported client	Windows 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Minimum KMDF version	1.15
Header	udecxusbendpoint.h (include Udecx.h)
IRQL	<=DISPATCH_LEVEL