WdfRequestRetrieveOutputBuffer 函式 (wdfrequest.h)
[適用於 KMDF 和 UMDF]
WdfRequestRetrieveOutputBuffer 方法會擷取 I/O 要求的輸出緩衝區。
語法
NTSTATUS WdfRequestRetrieveOutputBuffer(
[in] WDFREQUEST Request,
[in] size_t MinimumRequiredSize,
[out] PVOID *Buffer,
[out, optional] size_t *Length
);
參數
[in] Request
架構要求物件的句柄。
[in] MinimumRequiredSize
驅動程式需要處理 I/O 要求的最小緩衝區大小，以位元組為單位。
[out] Buffer
接收緩衝區位址之位置的指標。
[out, optional] Length
接收緩衝區大小之位置的指標，以位元組為單位。 此參數是選擇性的，可以是 NULL。
傳回值
如果作業成功，WdfRequestRetrieveOutputBuffer 會傳回STATUS_SUCCESS。 否則，此方法可能會傳回下列其中一個值：
| 傳回碼 | Description |
|---|---|
|
輸入參數無效。 |
|
輸出緩衝區的長度為零，或 MinimumRequiredSize 參數會指定大於緩衝區實際大小的緩衝區大小。 |
|
要求類型無效，或要求 未使用緩衝處理或直接 I/O。 如需有關存取數據緩衝區之支援方法的詳細資訊，請參閱下列一節。 |
|
要求已經完成。 |
|
記憶體不足。 |
這個方法也可能傳回其他 NTSTATUS值。
如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。
備註
要求的輸出緩衝區會接收來自磁碟的資訊，例如驅動程式提供給要求的來源者。 您的驅動程式可以呼叫 WdfRequestRetrieveOutputBuffer 來取得讀取要求或裝置 I/O 控制要求的輸出緩衝區，但不適用於寫入要求 (，因為寫入要求不會提供輸出數據) 。
WdfRequestRetrieveOutputBuffer 方法會擷取使用緩衝 I/O 方法或直接 I/O 方法來存取數據緩衝區的 I/O 要求的輸出緩衝區。 如果要求的 I/O 控制程式代碼 IRP_MJ_INTERNAL_DEVICE_CONTROL，或要求來自另一個內核模式驅動程式， WdfRequestRetrieveOutputBuffer 也支援使用 緩衝處理或直接 I/O 的 I/O 要求。
如果 WdfRequestRetrieveOutputBuffer 傳回STATUS_SUCCESS，驅動程式會接收位址，並選擇性地接收輸出緩衝區的大小。
驅動程式可以存取擷取的緩衝區，直到完成 Request 參數所代表的 I/O 要求為止。
驅動程式可以呼叫 WdfRequestRetrieveOutputMemory，而不是呼叫 WdfRequestRetrieveOutputMemory，這會建立代表緩衝區的架構記憶體物件。
如需 WdfRequestRetrieveOutputBuffer 的詳細資訊，請參閱 存取 Framework-Based 驅動程式中的數據緩衝區。
範例
下列程式代碼範例是 EvtIoDeviceControl 回呼 函式的一部分。 本範例會取得 USB 裝置的組態描述元，並將描述元放在 I/O 要求的輸出緩衝區中。
VOID
MyEvtIoDeviceControl(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t OutputBufferLength,
IN size_t InputBufferLength,
IN ULONG IoControlCode
)
{
WDFDEVICE device;
PDEVICE_CONTEXT pDevContext;
size_t bytesReturned = 0;
NTSTATUS status;
device = WdfIoQueueGetDevice(Queue);
//
// GetDeviceContext is a driver-defined function
// to retrieve device object context space.
//
pDevContext = GetDeviceContext(device);
switch(IoControlCode) {
case IOCTL_OSRUSBFX2_GET_CONFIG_DESCRIPTOR: {
PUSB_CONFIGURATION_DESCRIPTOR configurationDescriptor = NULL;
USHORT requiredSize;
//
// First, get the size of the USB configuration descriptor.
//
status = WdfUsbTargetDeviceRetrieveConfigDescriptor(
pDevContext->UsbDevice,
NULL,
&requiredSize
);
if (status == STATUS_BUFFER_TOO_SMALL) {
break;
}
//
// Get the buffer. Make sure the buffer is big
// enough to hold the configuration descriptor.
//
status = WdfRequestRetrieveOutputBuffer(
Request,
(size_t)requiredSize,
&configurationDescriptor,
NULL
);
if(!NT_SUCCESS(status)){
break;
}
//
// Now get the config descriptor.
//
status = WdfUsbTargetDeviceRetrieveConfigDescriptor(
pDevContext->UsbDevice,
configurationDescriptor,
&requiredSize
);
if (!NT_SUCCESS(status)) {
break;
}
bytesReturned = requiredSize;
}
break;
...
(Other case statements removed.)
...
default:
status = STATUS_INVALID_DEVICE_REQUEST;
break;
}
//
// Complete the request.
//
WdfRequestCompleteWithInformation(
Request,
status,
bytesReturned
);
return;
}
規格需求
| 需求 | 值 |
|---|---|
| 目標平台 | Universal |
| 最小 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) 、BufAfterReqCompletedReadA (kmdf) 、BufAfterReqCompletedWrite (kmdf) 、DriverCreate (kmdf) 、InvalidReqAccess (kmdf) 、InvalidReqAccessLocal (kmdf) 、 KmdfIrql (kmdf) 、KmdfIrql2 (kmdf) 、KmdfIrqlExplicit (kmdf) 、OutputBufferAPI (kmdf) |