UdecxUrbRetrieveControlSetupPacket function (udecxurb.h)

Retrieves a USB control setup packet from a specified framework request object.

Syntax

NTSTATUS UdecxUrbRetrieveControlSetupPacket(
  [in]  WDFREQUEST                    Request,
  [out] PWDF_USB_CONTROL_SETUP_PACKET SetupPacket
);

Parameters

[in] Request

A handle to a framework request object that represents the request containing the setup packet.

[out] SetupPacket

A WDF_USB_CONTROL_SETUP_PACKET structure that receives a setup packet describing the USB control transfer.

Return value

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

Remarks

The client driver can inspect contents of the setup packet to determine the standard control request that is sent to the device.

To complete the request, the driver must call UdecxUrbCompleteWithNtStatus.

Requirements

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

See also

Architecture: USB Device Emulation (UDE)

Write a UDE client driver