WDF_USB_CONTINUOUS_READER_CONFIG_INIT function (wdfusb.h)

[Applies to KMDF and UMDF]

The WDF_USB_CONTINUOUS_READER_CONFIG_INIT function initializes a WDF_USB_CONTINUOUS_READER_CONFIG structure.

Syntax

void WDF_USB_CONTINUOUS_READER_CONFIG_INIT(
  [out] PWDF_USB_CONTINUOUS_READER_CONFIG     Config,
  [in]  PFN_WDF_USB_READER_COMPLETION_ROUTINE EvtUsbTargetPipeReadComplete,
  [in]  WDFCONTEXT                            EvtUsbTargetPipeReadCompleteContext,
  [in]  size_t                                TransferLength
);

Parameters

[out] Config

A pointer to a WDF_USB_CONTINUOUS_READER_CONFIG structure.

[in] EvtUsbTargetPipeReadComplete

A pointer to the driver's EvtUsbTargetPipeReadComplete callback function.

[in] EvtUsbTargetPipeReadCompleteContext

An untyped pointer to driver-defined context information that the framework passes to the driver's EvtUsbTargetPipeReadComplete callback function.

[in] TransferLength

The maximum length, in bytes, of data that can be received from the device.

Return value

None

Remarks

The WDF_USB_CONTINUOUS_READER_CONFIG_INIT function zeros the specified WDF_USB_CONTINUOUS_READER_CONFIG structure and sets the structure's Size member. It also sets the structure's EvtUsbTargetPipeReadComplete, EvtUsbTargetPipeReadCompleteContext, and TransferLength members to the specified values.

Note that WDF_USB_CONTINUOUS_READER_CONFIG_INIT does not set the structure's EvtUsbTargetPipeReadersFailed member.

After calling WDF_USB_CONTINUOUS_READER_CONFIG_INIT, the driver can optionally add a EvtUsbTargetPipeReadersFailed pointer to the WDF_USB_CONTINUOUS_READER_CONFIG structure.

For a code example that uses WDF_USB_CONTINUOUS_READER_CONFIG_INIT, see WdfUsbTargetPipeConfigContinuousReader.

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfusb.h (include Wdfusb.h)

See also

EvtUsbTargetPipeReadComplete

WDF_USB_CONTINUOUS_READER_CONFIG