IWDFIoTarget2::FormatRequestForFlush 方法 (wudfddi.h)

[警告: UMDF 2 是最新版本的 UMDF,取代了 UMDF 1。 所有新的 UMDF 驱动程序都应使用 UMDF 2 编写。 未向 UMDF 1 添加新功能,并且较新版本的 Windows 10 上对 UMDF 1 的支持有限。 通用 Windows 驱动程序必须使用 UMDF 2。 有关详细信息,请参阅使用 UMDF 入门。]

FormatRequestForFlush 方法生成刷新操作的 I/O 请求,但不会将请求发送到 I/O 目标。

语法

HRESULT FormatRequestForFlush(
  [in]           IWDFIoRequest *pRequest,
  [in, optional] IWDFFile      *pFile
);

参数

[in] pRequest

指向表示 I/O 请求的请求对象的 IWDFIoRequest 接口的指针。

[in, optional] pFile

指向与 I/O 请求关联的文件对象的 IWDFFile 接口的指针。 此参数是可选的,可以为 NULL,但默认 I/O 目标需要此参数。

返回值

如果操作成功,FormatRequestForFlush 将返回S_OK。 否则,该方法可能会返回以下值之一:

返回代码 说明
E_OUTOFMEMORY
框架无法分配内存。
 

此方法可能会返回 Winerror.h 包含的其他值之一。

注解

某些驱动程序必须刷新较低驱动程序或设备中存在的缓存缓冲区。 例如,串行设备或存储设备的驱动程序堆栈中存在的驱动程序可能支持此操作。

使用 FormatRequestForFlush 方法(后跟 IWDFIoRequest::Send 方法)以同步或异步方式发送刷新请求。

示例

下面的代码示例是 IQueueCallbackDefaultIoHandler::OnDefaultIoHandler 回调函数的一部分。 如果回调函数收到刷新请求,则会将请求发送到设备的默认 I/O 目标。

void
CMyQueue::OnDefaultIoHandler(
 IWDFIoQueue*  pQueue,
 IWDFIoRequest*  pRequest
    )
{
    HRESULT hr;
    IWDFDevice *pDevice;
    IWDFIoTarget *pTarget;
    IWDFFile *pFile;

    //
    // Obtain the device, default I/O target, and file object.
    //
    pQueue->GetDevice(&pDevice);
    pDevice->GetDefaultIoTarget(&pTarget);
    pRequest->GetFileObject(&pFile);

    if (WdfRequestFlushBuffers==pRequest->GetType())
    {
        // 
        // Declare an IWDFIoTarget2 interface pointer and obtain the
        // IWDFIoTarget2 interface from the IWDFIoTarget interface.
        //
        CComQIPtr<IWDFIoTarget2> target2(pTarget);

        //
        // Format a flush request and send it to the I/O target.
        //
        hr = target2->FormatRequestForFlush(pRequest, 
                                            pFile);

        if (SUCCEEDED(hr))
        {
            hr = pRequest->Send(pTarget,
                                WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                                0);
        }
    }
...
    //
    // Release objects.
    //
    SAFE_RELEASE(pDevice);
    SAFE_RELEASE(pTarget);
    SAFE_RELEASE(pFile);
}

要求

要求
结束支持 在 UMDF 2.0 及更高版本中不可用。
目标平台 桌面
最低 UMDF 版本 1.9
标头 wudfddi.h (包括 Wudfddi.h)
DLL WUDFx.dll

另请参阅

IQueueCallbackDefaultIoHandler::OnDefaultIoHandler

IWDFIoRequest::Send

IWDFIoTarget2