IWDFIoRequest2::RetrieveOutputMemory メソッド (wudfddi.h)

[アーティクル]
08/08/2023

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。詳細については、「UMDF を使用したはじめに」を参照してください。

RetrieveOutputMemory メソッドは、I/O 要求の出力バッファーを表すフレームワークメモリオブジェクトの IWDFMemory インターフェイスを取得します。

構文

HRESULT RetrieveOutputMemory(
  [out] IWDFMemory **Memory
);

パラメーター

[out] Memory

UMDF メモリオブジェクトの IWDFMemory インターフェイスへのポインターを受け取る場所のアドレス。

戻り値

RetrieveOutputMemory は、操作が成功した場合にS_OKを返します。それ以外の場合、このメソッドは次の値を返すことができます。

リターンコード	説明
HRESULT_FROM_WIN32 (ERROR_INSUFFICIENT_BUFFER)	I/O 要求で入力バッファーが提供されませんでした。
E_OUTOFMEMORY	バッファーを取得するのに十分なメモリがありません。ドライバーは、エラー状態の値を使用して要求を完了する必要があります。

このメソッドは、Winerror.h に含まれる他の値のいずれかを返す場合があります。

注釈

要求の出力バッファーは、ドライバーが要求の発信元に提供する情報 (ディスクからのデータなど) を受け取ります。ドライバーは RetrieveOutputMemory を呼び出して、読み取り要求またはデバイス I/O 制御要求の出力バッファーを取得できますが、書き込み要求の場合は取得できません (書き込み要求では出力データが提供されないため)。

RetrieveOutputMemory メソッドは、バッファー処理された I/O メソッドまたは直接 I/O メソッドを使用してデータバッファーにアクセスする I/O 要求の出力バッファーを取得します。

RetrieveOutputMemory がS_OKを返す場合、ドライバーは出力バッファーを表す UMDF メモリオブジェクトの IWDFMemory インターフェイスへのポインターを受け取ります。バッファーにアクセスするには、ドライバーで IWDFMemory::GetDataBuffer を呼び出す必要があります。

ドライバーは、I/O 要求が完了するまで、取得したフレームワークメモリオブジェクトにアクセスできます。ドライバーは I/O 要求を完了する前に、 IWDFMemory::Release を呼び出す必要があります。

RetrieveOutputMemory を呼び出す代わりに、ドライバーは IWDFIoRequest2::RetrieveOutputBuffer を呼び出してバッファーのアドレスと長さを取得できます。

I/O 要求のデータバッファーへのアクセスの詳細については、「 UMDF-Based ドライバーでのデータバッファーへのアクセス」を参照してください。

例

次のコード例は、 IQueueCallbackRead::OnRead コールバック関数が、読み取り要求の出力バッファーを表すフレームワークメモリオブジェクトの IWDFMemory インターフェイスを取得する方法を示しています。次に、読み取り要求の書式を設定し、USB I/O ターゲットに送信します。

VOID
STDMETHODCALLTYPE
  CMyQueue::OnRead(
     __in IWDFIoQueue *pWdfQueue,
     __in IWDFIoRequest *pWdfRequest,
     __in SIZE_T BytesToRead
     )
{
    HRESULT hr = S_OK;
    IWDFMemory * pOutputMemory = NULL;

    //
    // Declare an IWDFIoRequest2 interface pointer and obtain the
    // IWDFIoRequest2 interface from the IWDFIoRequest interface.
    //
    CComQIPtr<IWDFIoRequest2> r2 = pWdfRequest;

    r2->RetrieveOutputMemory(&pOutputMemory);
    if (FAILED(hr)) goto Exit;

    hr = m_Device->GetInputPipe()->FormatRequestForRead(pWdfRequest,
                                                        NULL,
                                                        pOutputMemory,
                                                        NULL,
                                                        NULL);
Exit:
    if (FAILED(hr))
    {
        pWdfRequest->Complete(hr);
    }
    else
    {
        ForwardFormattedRequest(pWdfRequest, m_Device->GetInputPipe());
    }
    SAFE_RELEASE(pOutputMemory);
    return;
}

要件

要件	値
サポート終了	UMDF 2.0 以降では使用できません。
対象プラットフォーム	デスクトップ
最小 UMDF バージョン	1.9
Header	wudfddi.h (Wudfddi.h を含む)
[DLL]	WUDFx.dll