GetReadParameters method

[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 GetReadParameters method retrieves the request parameters for a read-type request.

Syntax

void  GetReadParameters(
  [out] SIZE_T   *pSizeInBytes,
  [out] LONGLONG *pllOffset,
  [out] ULONG    *pulKey
);

Parameters

pSizeInBytes

A pointer to a variable that receives the size, in bytes, to read. To retrieve the data for reading, the driver calls the IWDFIoRequest::GetOutputMemory method.

This parameter is optional. The driver can pass NULL if the driver does not require the information.

pullOffset

pulKey

A pointer to a variable that receives a key that the driver can use to sort the I/O request in a way that the driver determines.

This parameter is optional. The driver can pass NULL if the driver does not require the information.

Return Value

None

Remarks

A call to GetReadParameters fails if the request type is not a read type.

For devices that support addressing (for example, a disk device), the value that the pllOffset parameter points to is typically the byte offset into the device. For devices that do not support addressing (for example, a serial port), the driver can ignore the value at pllOffset.

Although the driver can optionally specify NULL for each of the pSizeInBytes, pllOffset, and pulKey parameters, the driver must specify at least one non-NULL parameter for GetReadParameters to execute successfully.

Requirements

   
End of support Unavailable in UMDF 2.0 and later.
Target Platform Desktop
Minimum UMDF version 1.5
Header wudfddi.h (include Wudfddi.h)
Library wudfddi.h
DLL WUDFx.dll

See Also

IWDFIoRequest::GetOutputMemory

IWDFIoRequest

Send comments about this topic to Microsoft