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，也不使用直接 I/O。 有关用于访问数据缓冲区的受支持方法的详细信息，请参阅以下“备注”部分。
STATUS_INTERNAL_ERROR
 请求已完成。
STATUS_INSUFFICIENT_RESOURCES
 内存不足。
 

此方法还可能返回其他 NTSTATUS 值。

如果驱动程序提供无效的对象句柄，则会发生 bug 检查。

注解

请求的输入缓冲区包含由请求发起方提供的信息，例如要写入磁盘的数据。 驱动程序可以调用 WdfRequestRetrieveInputBuffer 来获取写入请求或设备 I/O 控制请求的输入缓冲区，但对于读取请求 (，因为读取请求不提供输入数据) 。

WdfRequestRetrieveInputBuffer 方法检索使用缓冲 I/O 方法或直接 I/O 方法访问数据缓冲区的 I/O 请求的输入缓冲区。 如果请求的 I/O 控制代码 IRP_MJ_INTERNAL_DEVICE_CONTROL，或者请求来自另一个内核模式驱动程序， 则 WdfRequestRetrieveInputBuffer 还支持 既不使用缓冲 I/O，也不使用直接 I/O 的 I/O 请求。

如果 WdfRequestRetrieveInputBuffer 返回STATUS_SUCCESS，驱动程序将接收地址以及输入缓冲区的大小（可选）。

驱动程序可以访问检索到的缓冲区，直到它完成 Request 参数表示的 I/O 请求。

驱动程序可以调用 WdfRequestRetrieveInputBuffer，而不是调用 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)
Library 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