EVT_UCX_ENDPOINT_PURGE callback function (ucxendpoint.h)

The client driver's implementation that completes all outstanding I/O requests on the endpoint.

Syntax

EVT_UCX_ENDPOINT_PURGE EvtUcxEndpointPurge;

void EvtUcxEndpointPurge(
  [in] UCXCONTROLLER UcxController,
  [in] UCXENDPOINT UcxEndpoint
)
{...}

Parameters

[in] UcxController

A handle to the UCX controller that the client driver received in a previous call to the UcxControllerCreate method.

[in] UcxEndpoint

A handle to a UCXENDPOINT object that represents the endpoint.

Return value

None

Remarks

The UCX client driver registers this callback function with the USB host controller extension (UCX) by calling the UcxEndpointCreate method.

Typically, this function calls WdfIoQueuePurge.

After UCX calls this function, the client driver fails subsequent I/O requests until UCX calls the client driver's EVT_UCX_ENDPOINT_START callback function.

Examples

VOID
Endpoint_UcxEvtEndpointPurge(
    UCXCONTROLLER   UcxController,
    UCXENDPOINT     UcxEndpoint
    )
{
            WdfIoQueuePurge(endpointContext->WdfQueue,
                            Endpoint_WdfEvtPurgeComplete,
                            UcxEndpoint);
}

Requirements

Requirement	Value
Target Platform	Windows
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	ucxendpoint.h (include Ucxclass.h, Ucxendpoint.h)
IRQL	DISPATCH_LEVEL

See also

• WdfIoQueuePurge