WdfRequestRetrieveInputBuffer 函式 (wdfrequest.h)

  • 發行項

[適用于 KMDF 和 UMDF]

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

語法

NTSTATUS WdfRequestRetrieveInputBuffer(
  [in]            WDFREQUEST Request,
                  size_t     MinimumRequiredLength,
  [out]           PVOID      *Buffer,
  [out, optional] size_t     *Length
);

參數

[in] Request

架構要求物件的控制碼。

MinimumRequiredLength

驅動程式需要處理 I/O 要求的最小緩衝區大小，以位元組為單位。

[out] Buffer

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

[out, optional] Length

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

傳回值

如果作業成功，WdfRequestRetrieveInputBuffer會傳回STATUS_SUCCESS。 否則，這個方法可能會傳回下列其中一個值：

傳回碼 描述
STATUS_INVALID_PARAMETER
 輸入參數無效。
STATUS_BUFFER_TOO_SMALL
 輸入緩衝區的長度為零，或 MinimumRequiredSize 參數會指定大於緩衝區實際大小的緩衝區大小。
STATUS_INVALID_DEVICE_REQUEST
 要求類型無效，或要求 未使用緩衝處理或直接 I/O。 如需有關存取資料緩衝區之支援方法的詳細資訊，請參閱下列一節。
STATUS_INTERNAL_ERROR
 要求已經完成。
STATUS_INSUFFICIENT_RESOURCES
 記憶體不足。
 

這個方法也可能傳回其他 NTSTATUS 值。

如果驅動程式提供不正確物件控制碼，就會發生錯誤檢查。

備註

要求的輸入緩衝區包含資訊，例如要寫入磁片的資料，由要求的來源者提供。 驅動程式可以呼叫 WdfRequestRetrieveInputBuffer 來取得寫入要求或裝置 I/O 控制要求的輸入緩衝區，但不適用於讀取要求 (，因為讀取要求不提供輸入資料) 。

WdfRequestRetrieveInputBuffer方法會擷取使用緩衝 I/O方法的 I/O 要求的輸入緩衝區，或用於存取資料緩衝區的直接 I/O方法。 如果要求的 I/O 控制程式碼 IRP_MJ_INTERNAL_DEVICE_CONTROL，或要求來自另一個核心模式驅動程式， WdfRequestRetrieveInputBuffer 也支援使用 未緩衝或直接 I/O 的 I/O要求。

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

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

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

如需 WdfRequestRetrieveInputBuffer的詳細資訊，請參閱 存取Framework-Based驅動程式中的資料緩衝區。

範例

下列程式碼範例是 序列 範例驅動程式 EvtIoDeviceControl 回呼函式的一部分。 如果 I/O 控制項程式碼IOCTL_SERIAL_SET_TIMEOUT，驅動程式會從 I/O 要求的輸入緩衝區取得新的逾時值。

VOID
SerialEvtIoDeviceControl(
    IN WDFQUEUE     Queue,
    IN WDFREQUEST   Request,
    IN size_t       OutputBufferLength,
    IN size_t       InputBufferLength,
    IN ULONG        IoControlCode
    )
{
    PVOID  buffer;
    size_t  bufSize;

    switch (IoControlCode) {
...

        case IOCTL_SERIAL_SET_TIMEOUTS: {

            PSERIAL_TIMEOUTS NewTimeouts;

            Status = WdfRequestRetrieveInputBuffer(
                                                   Request,
                                                   sizeof(SERIAL_TIMEOUTS),
                                                   &buffer,
                                                   &bufSize
                                                   );
            if (!NT_SUCCESS(Status)) {
                break;
            }

            NewTimeouts =(PSERIAL_TIMEOUTS)buffer;
    }
...
}

規格需求

   
目標平臺 環球
最低 KMDF 版本 1.0
最低 UMDF 版本 2.0
標頭 wdfrequest.h (包含 Wdf.h)
程式庫 Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL <=DISPATCH_LEVEL
DDI 合規性規則 BufAfterReqCompletedIntIoctl (kmdf) 、 BufAfterReqCompletedIntIoctlA (kmdf) 、 BufAfterReqCompletedIoctl (kmdf ) 、 BufAfterReqCompletedIoctlA (kmdf) 、 BufAfterReqCompletedRead) (kmdf) 、 BufAfterReqCompletedWrite (kmdf) 、 BufAfterReqCompletedWriteA (kmdf ) 、 DriverCreate (kmdf ) 、InputBufferAPI (kmdf) 、 InvalidReqAccess (kmdf) 、 InvalidReqAccessLocal (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf )

另請參閱

WdfRequestRetrieveInputMemory

WdfRequestRetrieveOutputBuffer

WdfUsbTargetDeviceRetrieveConfigDescriptor