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

[アーティクル]
02/27/2024

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

RequestRetrieveOutputBuffer メソッドは、I/O 要求の出力バッファーを取得します。

構文

HRESULT RetrieveOutputBuffer(
  [in]            SIZE_T MinimumRequiredCb,
  [out]           PVOID  *Buffer,
  [out, optional] SIZE_T *BufferCb
);

パラメーター

[in] MinimumRequiredCb

ドライバーが I/O 要求を処理するために必要な最小バッファーサイズ (バイト単位)。最小バッファーサイズがない場合、この値は 0 にすることができます。

[out] Buffer

バッファーのアドレスを受け取る場所へのポインター。

[out, optional] BufferCb

バッファーのサイズをバイト単位で受け取る場所へのポインター。このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

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

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

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

注釈

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

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

RequestRetrieveOutputBuffer がS_OKを返す場合、ドライバーはアドレスと、必要に応じて出力バッファーのサイズを受け取ります。

ドライバーは、I/O 要求が完了するまで取得したバッファーにアクセスできます。

RequestRetrieveOutputBuffer を呼び出す代わりに、ドライバーは IWDFIoRequest2::RetrieveOutputMemory を呼び出すことができます。これにより、バッファーを表すフレームワークメモリオブジェクトが作成されます。

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

例

次のコード例は、シリアルポートドライバーの IQueueCallbackDeviceIoControl::OnDeviceIoControl コールバック関数のセグメントを示しています。コードセグメントは、I/O 要求の出力バッファーを取得し、デバイスからバッファーにボーレート情報を転送します。

VOID
STDMETHODCALLTYPE
  CMyQueue::OnDeviceIoControl(
    __in IWDFIoQueue *pWdfQueue,
    __in IWDFIoRequest *pWdfRequest,
    __in ULONG ControlCode,
    __in SIZE_T InputBufferSizeInBytes,
    __in SIZE_T OutputBufferSizeInBytes
    )
{
    HRESULT hr;
    //
    // Declare an IWDFIoRequest2 interface pointer and obtain the
    // IWDFIoRequest2 interface from the IWDFIoRequest interface.
    //
    CComQIPtr<IWDFIoRequest2> r2 = pWdfRequest;

    switch (ControlCode)
    {
        case IOCTL_SERIAL_GET_BAUD_RATE:
        {
            SERIAL_BAUD_RATE *pBaudRateBuffer;
            hr = pWdfRequest2->RetrieveOutputBuffer(sizeof(SERIAL_BAUD_RATE),
                                                    (PVOID*) &pBaudRateBuffer,
                                                    NULL);
            if (SUCCEEDED(hr))
                  {
                      RtlZeroMemory(pBaudRateBuffer, sizeof(SERIAL_BAUD_RATE));
                      pBaudRateBuffer->BaudRate = m_Device->GetBaudRate();
                      reqCompletionInfo = sizeof(SERIAL_BAUD_RATE);
                  }
            
        }
        break;
        ...
    }
    ...
}

要件

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