WdfRequestRetrieveOutputMemory 函数 (wdfrequest.h)

[适用于 KMDF 和 UMDF]

WdfRequestRetrieveOutputMemory 方法检索表示 I/O 请求输出缓冲区的框架内存对象的句柄。

语法

NTSTATUS WdfRequestRetrieveOutputMemory(
  [in]  WDFREQUEST Request,
  [out] WDFMEMORY  *Memory
);

参数

[in] Request

框架请求对象的句柄。

[out] Memory

指向位置的指针，该位置接收框架内存对象的句柄。

返回值

如果操作成功，WdfRequestRetrieveOutputMemory 将返回STATUS_SUCCESS。 否则，此方法可能会返回以下值之一：

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

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

注解

请求的输出缓冲区接收驱动程序提供给请求发起者的信息，例如来自磁盘的数据。 驱动程序可以调用 WdfRequestRetrieveOutputMemory 来获取读取请求或设备 I/O 控制请求的输出缓冲区，但对于写入请求 (，因为写入请求不提供输出数据) 。

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

如果 WdfRequestRetrieveOutputMemory 返回STATUS_SUCCESS，驱动程序将收到表示输出缓冲区的框架内存对象的句柄。 若要访问缓冲区，驱动程序必须调用 WdfMemoryGetBuffer。

驱动程序可以访问检索到的框架内存对象，直到它完成 Request 参数表示的 I/O 请求。

驱动程序可以调用 WdfRequestRetrieveOutputBuffer，以检索缓冲区的地址和长度，而不是调用 WdfRequestRetrieveOutputMemory。

有关 WdfRequestRetrieveOutputMemory 的详细信息，请参阅 访问 Framework-Based 驱动程序中的数据缓冲区。

示例

下面的代码示例演示 EvtIoRead 回调函数如何获取表示读取请求输出缓冲区的框架内存对象的句柄。 然后，该示例格式化读取请求并将其发送到 USB I/O 目标。

VOID 
MyEvtIoRead(
    IN WDFQUEUE  Queue,
    IN WDFREQUEST  Request,
    IN size_t  Length
    )
{
    WDFUSBPIPE  pipe;
    NTSTATUS  status;
    WDFMEMORY  reqMemory;
    PDEVICE_CONTEXT  pDeviceContext;

    //
    // The driver previously stored a pipe handle in 
    // the device object's context space.
    //
    pDeviceContext = GetDeviceContext(WdfIoQueueGetDevice(Queue));
    pipe = pDeviceContext->BulkReadPipe;

    //
    // Get output memory.
    //
    status = WdfRequestRetrieveOutputMemory(
                                            Request,
                                            &reqMemory
                                            );
    if(!NT_SUCCESS(status)){
        goto Exit;
    }
    //
    // Format the request.
    //
    status = WdfUsbTargetPipeFormatRequestForRead(
                                           pipe,
                                           Request,
                                           reqMemory,
                                           NULL
                                           ); 
    if (!NT_SUCCESS(status)) {
        goto Exit;
    }
    WdfRequestSetCompletionRoutine(
                                   Request,
                                   EvtRequestReadCompletionRoutine,
                                   pipe
                                   );
    //
    // Send the request.
    //
    if (WdfRequestSend(
                       Request,
                       WdfUsbTargetPipeGetIoTarget(pipe),
                       WDF_NO_SEND_OPTIONS
                       ) == FALSE) {
        status = WdfRequestGetStatus(Request);
        goto Exit;
    }
Exit:
    //
    // Complete the request now if an error occurred.
    //
    if (!NT_SUCCESS(status)) {
        WdfRequestCompleteWithInformation(
                                          Request,
                                          status,
                                          0
                                          );
    }
    return;
}

要求

另请参阅

WdfMemoryGetBuffer

WdfRequestRetrieveInputMemory

WdfRequestRetrieveOutputBuffer