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
Header wudfddi.h (Wudfddi.h を含む)
[DLL] WUDFx.dll

こちらもご覧ください

IQueueCallbackDefaultIoHandler::OnDefaultIoHandler

IWDFIoRequest::Send

IWDFIoTarget2