IWDFUsbRequestCompletionParams::GetPipeReadParameters method (wudfusb.h)

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

The GetPipeReadParameters method retrieves parameters that are associated with the completion of a read request.

Syntax

void GetPipeReadParameters(
  [out, optional] IWDFMemory **ppReadMemory,
  [out, optional] SIZE_T     *pBytesRead,
  [out, optional] SIZE_T     *pReadMemoryOffset
);

Parameters

[out, optional] ppReadMemory

A pointer to a variable that receives a pointer to the IWDFMemory interface, for access to the read buffer for the read request. This parameter is optional and can be NULL.

[out, optional] pBytesRead

A pointer to a variable that receives the size, in bytes, of the read buffer for the read request. This parameter is optional and can be NULL.

[out, optional] pReadMemoryOffset

A pointer to a variable that receives the offset, in bytes, into the read buffer for the read request. This parameter is optional and can be NULL.

Return value

None

Requirements

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.5
Header	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

See also

IWDFMemory

IWDFUsbRequestCompletionParams