IWDFIoTarget::FormatRequestForIoctl 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 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

pRequest [in]

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

IoctlCode [in]

A control code that identifies a specific operation to perform.

pFile [in, optional]

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.

pInputMemory [in, optional]

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

pInputMemoryOffset [in, optional]

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

pOutputMemory [in, optional]

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

pOutputMemoryOffset [in, optional]

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

Target platform

Desktop

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: