WdfRequestRetrieveInputMemory 函式 (wdfrequest.h)
[適用於 KMDF 和 UMDF]
WdfRequestRetrieveInputMemory 方法會擷取架構記憶體物件的句柄，此物件代表 I/O 要求的輸入緩衝區。
語法
NTSTATUS WdfRequestRetrieveInputMemory(
[in] WDFREQUEST Request,
[out] WDFMEMORY *Memory
);
參數
[in] Request
架構要求物件的句柄。
[out] Memory
接收架構記憶體物件句柄的位置指標。
傳回值
如果作業成功，WdfRequestRetrieveInputMemory 會傳回STATUS_SUCCESS。 否則，此方法可能會傳回下列其中一個值：
| 傳回碼 | Description |
|---|---|
|
輸入參數無效。 |
|
要求類型無效，或要求 未使用緩衝處理或直接 I/O。 如需有關存取數據緩衝區之支援方法的詳細資訊，請參閱下列一節。 |
|
要求已經完成。 |
|
輸入緩衝區的長度為零。 |
|
記憶體不足。 |
這個方法也可能傳回其他 NTSTATUS值。
如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。
備註
要求的輸入緩衝區包含資訊，例如要寫入磁碟的數據，由要求的來源者提供。 您的驅動程式可以呼叫 WdfRequestRetrieveInputMemory 來取得寫入要求或裝置 I/O 控制要求的輸入緩衝區，但不適用於讀取要求 (，因為讀取要求不會提供輸入數據) 。
WdfRequestRetrieveInputMemory 方法會擷取使用緩衝 I/O 方法或直接 I/O 方法來存取數據緩衝區的 I/O 要求輸入緩衝區。 如果要求的 I/O 控制程式代碼 IRP_MJ_INTERNAL_DEVICE_CONTROL，或要求來自另一個內核模式驅動程式， WdfRequestRetrieveInputMemory 也支援使用 緩衝處理或直接 I/O 的 I/O 要求。
如果 WdfRequestRetrieveInputMemory 傳回STATUS_SUCCESS，驅動程式會接收代表輸入緩衝區的架構記憶體物件的句柄。 若要存取緩衝區，驅動程式必須呼叫 WdfMemoryGetBuffer。
驅動程式可以存取擷取的架構記憶體物件，直到完成 Request 參數所代表的 I/O 要求為止。
驅動程式可以呼叫 WdfRequestRetrieveInputMemory，而不是呼叫 WdfRequestRetrieveInputBuffer，以擷取緩衝區的位址和長度。
如需 WdfRequestRetrieveInputMemory 的詳細資訊，請參閱 存取 Framework-Based 驅動程式中的數據緩衝區。
範例
下列程式代碼範例示範 EvtIoWrite 回呼函式如何取得架構記憶體物件的句柄，此物件代表寫入要求的輸入緩衝區。 然後，此範例會將寫入要求格式化並傳送至USB I/O目標。
VOID
MyEvtIoWrite(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t Length
)
{
NTSTATUS status;
WDFUSBPIPE pipe;
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->BulkWritePipe;
//
// Get input memory.
//
status = WdfRequestRetrieveInputMemory(
Request,
&reqMemory
);
if(!NT_SUCCESS(status)){
goto Exit;
}
//
// Format the request.
//
status = WdfUsbTargetPipeFormatRequestForWrite(
pipe,
Request,
reqMemory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
EvtRequestWriteCompletionRoutine,
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;
}
規格需求
| 需求 | 值 |
|---|---|
| 目標平台 | Universal |
| 最小 KMDF 版本 | 1.0 |
| 最低UMDF版本 | 2.0 |
| 標頭 | wdfrequest.h (包含 Wdf.h) |
| 程式庫 | Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF) |
| IRQL | <=DISPATCH_LEVEL |
| DDI 合規性規則 | DriverCreate (kmdf) 、 InputBufferAPI (kmdf) 、 InvalidReqAccess (kmdf) 、 InvalidReqAccessLocal (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、KmdfIrqlExplicit (kmdf) 、 MemAfterReqCompletedIntIoctl (kmdf) 、 MemAfterReqCompletedIntIoctlA (kmdf) 、 MemAfterReqCompletedIoctl (kmdf) 、 MemAfterReqCompletedIoctlA (kmdf) 、 MemAfterReqCompletedRead (kmdf) 、 MemAfterReqCompletedWrite (kmdf) 、 MemAfterReqCompletedWriteA (kmdf) |