IWDFIoTarget::FormatRequestForRead method

The FormatRequestForRead method formats an I/O request object for a read operation.

Syntax


HRESULT FormatRequestForRead(
  [in]           IWDFIoRequest     *pRequest,
  [in, optional] IWDFFile          *pFile,
  [in, optional] IWDFMemory        *pOutputMemory,
  [in, optional] PWDFMEMORY_OFFSET pOutputMemoryOffset,
  [in, optional] PLONGLONG         DeviceOffset
);

Parameters

pRequest [in]

A pointer to the IWDFIoRequest interface for the request object to format.

pFile [in, optional]

A pointer to the IWDFFile interface for the file object that is associated with the read request. For the default I/O target, this parameter must be non-NULL.

pOutputMemory [in, optional]

A pointer to the IWDFMemory interface that is used to access the buffer that is used for the read request. This parameter is optional.

pOutputMemoryOffset [in, optional]

A pointer to a WDFMEMORY_OFFSET structure that describes the output memory offset that is used for the read. This parameter is optional.

DeviceOffset [in, optional]

A pointer to the device offset that is used for the read. This parameter is optional.

Return value

FormatRequestForRead returns S_OK if the operation succeeds. Otherwise, this method returns one of the error codes that are defined in Winerror.h.

Examples

For a code example of how to use the FormatRequestForRead method, see IWDFDevice::CreateRequest.

Requirements

Target platform

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.5

Header

Wudfddi.h (include Wudfddi.h)

DLL

WUDFx.dll

See also

IWDFIoTarget
IWDFFile
IWDFIoRequest
IWDFMemory
WDFMEMORY_OFFSET

 

 

Send comments about this topic to Microsoft

Show: