IWDFIoTarget::FormatRequestForWrite method (wudfddi.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 FormatRequestForWrite method formats an I/O request object for a write operation.

Syntax

HRESULT FormatRequestForWrite(
  [in]           IWDFIoRequest     *pRequest,
  [in, optional] IWDFFile          *pFile,
  [in, optional] IWDFMemory        *pInputMemory,
  [in, optional] PWDFMEMORY_OFFSET pInputMemoryOffset,
  [in, optional] PLONGLONG         DeviceOffset
);

Parameters

[in] pRequest

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

[in, optional] pFile

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

[in, optional] pInputMemory

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

[in, optional] pInputMemoryOffset

A pointer to a WDFMEMORY_OFFSET structure that describes the input memory offset that is used for the write request. This parameter is optional.

[in, optional] DeviceOffset

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

Return value

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

Requirements

See also

IWDFFile

IWDFIoRequest

IWDFIoTarget

IWDFMemory

WDFMEMORY_OFFSET