Edit

IWDFIoTarget::FormatRequestForIoctl method (wudfddi.h)

  • Article

[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 FormatRequestForIoctl method formats an I/O request object for an I/O control operation.

Syntax

HRESULT FormatRequestForIoctl(
  [in]           IWDFIoRequest     *pRequest,
  [in]           ULONG             IoctlCode,
  [in, optional] IWDFFile          *pFile,
  [in, optional] IWDFMemory        *pInputMemory,
  [in, optional] PWDFMEMORY_OFFSET pInputMemoryOffset,
  [in, optional] IWDFMemory        *pOutputMemory,
  [in, optional] PWDFMEMORY_OFFSET pOutputMemoryOffset
);

Parameters

[in] pRequest

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

[in] IoctlCode

A control code that identifies a specific operation to perform.

[in, optional] pFile

A pointer to the IWDFFile interface for the file object that is associated with the I/O control 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 input buffer for the request. This parameter is optional.

[in, optional] pInputMemoryOffset

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

[in, optional] pOutputMemory

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

[in, optional] pOutputMemoryOffset

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

Return value

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

Requirements

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

See also

IWDFFile

IWDFIoRequest

IWDFIoTarget

IWDFMemory

WDFMEMORY_OFFSET