WdfIoTargetSendWriteSynchronously 函式 (wdfiotarget.h)
[適用於 KMDF 和 UMDF]
WdfIoTargetSendWriteSynchronously 方法會建置寫入要求,並將它同步傳送至 I/O 目標。
語法
NTSTATUS WdfIoTargetSendWriteSynchronously(
[in] WDFIOTARGET IoTarget,
[in, optional] WDFREQUEST Request,
[in, optional] PWDF_MEMORY_DESCRIPTOR InputBuffer,
[in, optional] PLONGLONG DeviceOffset,
[in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
[out, optional] PULONG_PTR BytesWritten
);
參數
[in] IoTarget
從先前呼叫 WdfDeviceGetIoTarget 或 WdfIoTargetCreate 取得的本機或遠端 I/O 目標物件的句柄,或從特製化 I/O 目標所提供的方法取得。
[in, optional] Request
架構要求物件的句柄。 此參數是選擇性的,可以是 NULL。 如需此參數的詳細資訊,請參閱下列一節。
[in, optional] InputBuffer
呼叫端配置的 WDF_MEMORY_DESCRIPTOR 結構的指標,描述將寫入裝置之數據的緩衝區。 此參數是選擇性的,可以是 NULL。 如需此參數的詳細資訊,請參閱下列一節。
[in, optional] DeviceOffset
指定傳輸起始位移之位置的指標。 I/O 目標 (,也就是下一個較低的驅動程式) 會定義如何使用此值。 例如,磁碟驅動程式堆疊中的驅動程式可能會指定磁碟開頭的位移。 I/O 目標會在要求的 WDF_REQUEST_PARAMETERS 結構之 Parameters.Write.DeviceOffset 成員中取得這項資訊。 此指標是選擇性的。 大部分驅動程式都會將此指標設定為 NULL。
[in, optional] RequestOptions
呼叫端配置的 WDF_REQUEST_SEND_OPTIONS 結構的指標,指定要求的選項。 此指標是選擇性的,可以是 NULL。 如需此參數的詳細資訊,請參閱下列一節。
[out, optional] BytesWritten
如果作業成功,則為接收寫入位元組數目的位置指標。 此指標是選擇性的,可以是 NULL。
傳回值
如果作業成功, WdfIoTargetSendWriteSynchronous 會在 I/O 要求完成之後傳回,而傳回值為要求的完成狀態值。 否則,此方法可能會傳回下列其中一個值:
傳回碼 | Description |
---|---|
|
偵測到無效的參數。 |
|
RequestOptions 參數指向的WDF_REQUEST_SEND_OPTIONS結構大小不正確。 |
|
I/O 要求已排入 I/O 目標佇列。 |
|
架構無法配置系統資源, (通常是記憶體) 。 |
|
驅動程式提供了逾時值,而且要求未在分配的時間內完成。 |
|
要求參數所代表的 I/O 要求封包 (IRP) 沒有足夠的IO_STACK_LOCATION結構,可讓驅動程式轉送要求。 |
這個方法也可能傳回其他 NTSTATUS值。
如果驅動程式提供無效的物件句柄,就會發生錯誤檢查。
備註
使用 WdfIoTargetSendWriteSynchronously 方法來同步傳送寫入要求。 若要以異步方式傳送寫入要求,請使用 WdfIoTargetFormatRequestForWrite 方法,後面接著 WdfRequestSend 方法。
除非驅動程式在 RequestOptions 參數的 WDF_REQUEST_SEND_OPTIONS 結構中提供逾時值,否則 WdfIoTargetSendWriteSynchronously 不會傳回,除非偵測到錯誤。
您可以轉送驅動程式在 I/O 佇列中收到的 I/O 要求,也可以建立並傳送新的要求。 不論是哪一種情況,架構都需要要求物件和一些緩衝區空間。
若要轉送驅動程式在 I/O 佇列中收到的 I/O 要求:
- 為 WdfIoTargetSendWriteSynchronously 方法的 Request 參數指定收到的要求句柄。
-
針對 WdfIoTargetSendWriteSynchronously 方法的 InputBuffer 參數,使用收到的要求輸入緩衝區。
驅動程式必須呼叫 WdfRequestRetrieveInputMemory,以取得架構記憶體物件的句柄,該物件代表要求的輸入緩衝區,然後將該句柄放在驅動程式為 InputBuffer 參數提供的WDF_MEMORY_DESCRIPTOR結構中。
驅動程式通常會將收到的 I/O 要求分成較小的要求,這些要求會傳送至 I/O 目標,因此您的驅動程式可能會建立新的要求。
若要建立新的 I/O 要求:
-
提供 WdfIoTargetSendWriteSynchronously 方法的 Request 參數的 NULL 要求句柄,或建立新的要求物件並提供其句柄:
- 如果您提供 NULL 要求句柄,架構會使用內部要求物件。 這項技術很容易使用,但驅動程式無法取消要求。
- 如果您呼叫 WdfRequestCreate 來建立一或多個要求物件,您可以呼叫 WdfRequestReuse 來重複使用這些要求物件。 這項技術可讓驅動程式的 EvtDriverDeviceAdd 回呼函式預先配置裝置的要求物件。 此外,另一個驅動程式線程可以視需要呼叫 WdfRequestCancelSentRequest 來取消要求。
不論驅動程式是否提供非 NULL 或NULL要求參數,您的驅動程式都可以指定非 NULLRequestOptions 參數。 例如,您可以使用 RequestOptions 參數來指定逾時值。
-
為 WdfIoTargetSendWriteSynchronously 方法的 InputBuffer 參數提供緩衝區空間。
您的驅動程式可以將此緩衝區空間指定為本機配置的緩衝區、WDFMEMORY 句柄或記憶體描述元清單, (MDL) 。 您可以使用哪一種方法最方便。
如有必要,架構會將緩衝區描述轉換成 I/O 目標方法的正確緩衝區描述 ,以存取數據緩衝區。
下列指定緩衝區空間的技術可供使用:
-
提供本機緩衝區。
由於 WdfIoTargetSendWriteSynchronously 會同步處理 I/O 要求,因此驅動程式可以建立呼叫例程本機的要求緩衝區,如下列程式代碼範例所示。
WDF_MEMORY_DESCRIPTOR MemoryDescriptor; MY_BUFFER_TYPE MyBuffer; WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&MemoryDescriptor, (PVOID) &MyBuffer, sizeof(MyBuffer));
-
提供WDFMEMORY句柄。
呼叫 WdfMemoryCreate 或 WdfMemoryCreatePreallocated 以取得架構管理的記憶體句柄,如下列程式代碼範例所示。
WDF_MEMORY_DESCRIPTOR MemoryDescriptor; WDFMEMORY MemoryHandle = NULL; status = WdfMemoryCreate(NULL, NonPagedPool, POOL_TAG, MY_BUFFER_SIZE, &MemoryHandle, NULL); WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&MemoryDescriptor, MemoryHandle, NULL);
或者,如果您想要驅動程式將該緩衝區的內容傳遞至 I/O 目標,則驅動程式可以呼叫 WdfRequestRetrieveInputMemory ,以取得架構記憶體物件的句柄,代表所接收 I/O 要求的輸入緩衝區。 在 WdfIoTargetSendWriteSynchronously 傳送 至 I/O 目標的新要求已刪除、重複使用或重新格式化之前,驅動程式不得完成收到的 I/O 要求。 (WdfIoTargetSendWriteSynchronous 遞 增記憶體對象的參考計數。刪除、重複使用或重新格式化要求物件會遞減記憶體對象的參考計數。)
-
提供 MDL。
驅動程式可以藉由呼叫 WdfRequestRetrieveInputWdmMdl 來取得與已接收 I/O 要求相關聯的 MDL。
-
提供本機緩衝區。
如需 I/O 要求完成之後取得狀態資訊的相關信息,請參閱 取得完成資訊。
如需 WdfIoTargetSendWriteSynchronously 的詳細資訊,請參閱 將 I/O 要求傳送至一般 I/O 目標。
如需 I/O 目標的詳細資訊,請參閱 使用 I/O 目標。
範例
下列程式代碼範例會建立架構記憶體物件、初始化 WDF_MEMORY_DESCRIPTOR 結構,並將 結構傳遞至 WdfIoTargetSendWriteSynchronously。 本範例會指定要求物件句柄的 NULL ,因此架構會為 I/O 目標建立新的要求物件。
WDF_MEMORY_DESCRIPTOR MemoryDescriptor;
WDFMEMORY MemoryHandle = NULL;
ULONG_PTR bytesWritten = NULL;
status = WdfMemoryCreate(
NULL,
NonPagedPool,
POOL_TAG,
MY_BUFFER_SIZE,
&MemoryHandle,
NULL
);
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(
&MemoryDescriptor,
MemoryHandle,
NULL
);
status = WdfIoTargetSendWriteSynchronously(
ioTarget,
NULL,
&MemoryDescriptor,
NULL,
NULL,
&bytesWritten
);
規格需求
需求 | 值 |
---|---|
目標平台 | Universal |
最小 KMDF 版本 | 1.0 |
最低UMDF版本 | 2.0 |
標頭 | wdfiotarget.h (包含 Wdf.h) |
程式庫 | Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF) |
IRQL | <=PASSIVE_LEVEL |
DDI 合規性規則 | DeferredRequestCompleted (kmdf) 、 DriverCreate (kmdf ) 、 InternalIoctlReqs (kmdf) 、 IoctlReqs () kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、KmdfIrqlExplicit (kmdf) 、 ReadReqs (kmdf) 、 RequestCompleted (kmdf ) 、 RequestCompletedLocal (kmdf) 、 SyncReqSend (kmdf) |
另請參閱
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應