IWDFIoRequest2：：RetrieveInputBuffer 方法 (wudfddi.h)

發行項
03/01/2024

[警告： UMDF 2 是最新版的 UMDF，並取代 UMDF 1。所有新的UMDF驅動程式都應該使用UMDF 2撰寫。未將新功能新增至 UMDF 1，而且較新版本的 Windows 10 上，UMDF 1 的支援有限。通用 Windows 驅動程式必須使用 UMDF 2。如需詳細資訊，請參閱使用 UMDF 使用者入門。]

RequestRetrieveInputBuffer 方法會擷取 I/O 要求的輸入緩衝區。

語法

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

參數

[in] MinimumRequiredCb

驅動程式需要處理 I/O 要求的最小緩衝區大小，以位元組為單位。如果沒有緩衝區大小下限，這個值可以是零。

[out] Buffer

接收緩衝區位址之位置的指標。

[out, optional] BufferCb

接收緩衝區大小之位置的指標，以位元組為單位。這個參數是選擇性的，而且可以是 NULL。

傳回值

如果作業成功，RequestRetrieveInputBuffer 會傳回S_OK。否則，這個方法可以傳回下列值：

傳回碼	Description
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	I/O 要求未提供輸入緩衝區，或輸入緩衝區的大小小於 MinimumRequiredCb 指定的最小大小。
E_OUTOFMEMORY	記憶體不足，無法擷取緩衝區。驅動程式應該會以錯誤狀態值完成要求。

這個方法可能會傳回 Winerror.h 包含的其他其中一個值。

備註

要求的輸入緩衝區包含資訊，例如要寫入磁碟的數據，也就是所提供要求的來源。驅動程式可以呼叫 RequestRetrieveInputBuffer 來取得寫入要求或裝置 I/O 控制要求的輸入緩衝區，但不適用於讀取要求 (，因為讀取要求不提供輸入數據) 。

RequestRetrieveInputBuffer 方法會擷取使用緩衝 I/O 或直接 I/O 方法來存取數據緩衝區的 I/O 要求的輸入緩衝區。

如果 RequestRetrieveInputBuffer 傳回S_OK，驅動程式會接收位址，並選擇性地接收輸入緩衝區的大小。

驅動程式可以存取擷取的緩衝區，直到它完成 I/O 要求為止。

驅動程式可以呼叫 IWDFIoRequest2：：RetrieveInputMemory，而不是呼叫 RequestRetrieveInputBuffer，這會建立代表緩衝區的架構記憶體物件。

如需存取 I/O 要求數據緩衝區的詳細資訊，請參閱存取 UMDF-Based 驅動程式中的數據緩衝區。

範例

下列程式代碼範例顯示序列埠驅動程式 IQueueCallbackDeviceIoControl：：OnDeviceIoControl 回呼函式的區段。從 I/O 要求的輸入緩衝區，程式代碼區段會取得應該為裝置設定的傳輸速率。

VOID
STDMETHODCALLTYPE
  CMyQueue::OnDeviceIoControl(
    __in IWDFIoQueue*  FxQueue,
    __in IWDFIoRequest*  FxRequest,
    __in ULONG  ControlCode,
    __in SIZE_T  InputBufferCb,
    __in SIZE_T  OutputBufferCb
    )
{
    PBYTE buffer;
    SIZE_T bufferSize;
    HRESULT hr;
    //
    // Declare an IWDFIoRequest2 interface pointer and obtain the
    // IWDFIoRequest2 interface from the IWDFIoRequest interface.
    //
    CComQIPtr<IWDFIoRequest2> r2 = FxRequest;

    switch (ControlCode)
    {
        case IOCTL_SERIAL_SET_BAUD_RATE: 
        {
            //
            // Obtain the baud rate from the write request's input buffer.
            //
            hr = r2->RetrieveInputBuffer(sizeof(SERIAL_BAUD_RATE),
                                         (PVOID*) &buffer, 
                                         &bufferSize);
...
        }
    }
}

規格需求

需求	值
終止支援	在 UMDF 2.0 和更新版本中無法使用。
目標平台	桌面
最低UMDF版本	1.9
標頭	wudfddi.h (包含 Wudfddi.h)
Dll	WUDFx.dll