共用方式為


WdfIoTargetFormatRequestForInternalIoctl 函式 (wdfiotarget.h)

[僅適用於 KMDF]

WdfIoTargetFormatRequestForInternalIoctl 方法會建置 I/O 目標的內部裝置控制要求,但不會傳送要求。

語法

NTSTATUS WdfIoTargetFormatRequestForInternalIoctl(
  [in]           WDFIOTARGET       IoTarget,
  [in]           WDFREQUEST        Request,
  [in]           ULONG             IoctlCode,
  [in, optional] WDFMEMORY         InputBuffer,
  [in, optional] PWDFMEMORY_OFFSET InputBufferOffset,
  [in, optional] WDFMEMORY         OutputBuffer,
  [in, optional] PWDFMEMORY_OFFSET OutputBufferOffset
);

參數

[in] IoTarget

從先前呼叫 WdfDeviceGetIoTargetWdfIoTargetCreate 取得的本機或遠端 I/O 目標物件的句柄,或從特製化 I/O 目標所提供的方法取得。

[in] Request

架構要求物件的句柄。 如需詳細資訊,請參閱接下來的<備註>一節。

[in] IoctlCode

I/O 控制項程式代碼 (IOCTL) I/O 目標支援。

[in, optional] InputBuffer

架構記憶體物件的句柄。 這個物件代表緩衝區,其中包含將傳送至 I/O 目標的數據。 如需詳細資訊,請參閱接下來的<備註>一節。

[in, optional] InputBufferOffset

呼叫端配置的 WDFMEMORY_OFFSET 結構的指標,可提供選擇性的位元移和長度值。 架構會使用這些值來判斷輸入緩衝區內的起始位址和長度,以進行數據傳輸。 如果此指標為 NULL,則數據傳輸會從輸入緩衝區的開頭開始,而傳輸大小則是緩衝區大小。

[in, optional] OutputBuffer

架構記憶體物件的句柄。 這個物件代表將接收來自I/O目標的數據的緩衝區。 如需詳細資訊,請參閱接下來的<備註>一節。

[in, optional] OutputBufferOffset

呼叫端配置的 WDFMEMORY_OFFSET 結構的指標,可提供選擇性的位元移和長度值。 架構會使用這些值來判斷輸出緩衝區內的起始位址和長度,以進行數據傳輸。 如果此指標為 NULL,則數據傳輸會從輸出緩衝區的開頭開始,而傳輸大小則是緩衝區大小。

傳回值

WdfIoTargetFormatRequestForInternalIoctl 會在作業成功時傳回STATUS_SUCCESS。 否則,此方法可能會傳回下列其中一個值:

傳回碼 Description
STATUS_INVALID_PARAMETER
偵測到無效的參數。
STATUS_INVALID_DEVICE_REQUEST
傳輸長度大於緩衝區長度,或 I/O 要求已排入 I/O 目標佇列。
STATUS_INSUFFICIENT_RESOURCES
架構無法配置系統資源, (通常是記憶體) 。
STATUS_REQUEST_NOT_ACCEPTED
要求參數所代表的 I/O 要求封包 (IRP) 沒有足夠的IO_STACK_LOCATION結構,可讓驅動程式轉送要求。
 

這個方法也可能傳回其他 NTSTATUS值

如果驅動程式提供無效的物件句柄,就會發生錯誤檢查。

備註

使用 WdfIoTargetFormatRequestForInternalIoctl 方法,後面接著 WdfRequestSend 方法,以同步或異步方式傳送內部裝置控制要求。 或者,使用 WdfIoTargetSendInternalIoctlSynchronously 方法來同步傳送內部裝置控制要求。

如需內部裝置控制要求的詳細資訊,請參閱 使用 I/O 控制代碼

您可以轉送驅動程式在 I/O 佇列中收到的內部裝置控制要求,也可以建立並傳送新的要求。 不論是哪一種情況,架構都需要要求物件和一些緩衝區空間。

若要轉送驅動程式在 I/O 佇列中收到的內部裝置控制要求:

  1. WdfIoTargetFormatRequestForInternalIoctl 方法的 Request 參數指定收到的要求句柄。
  2. 針對 WdfIoTargetFormatRequestForInternalIoctl 方法的 InputBuffer 參數,使用收到的要求輸入緩衝區。

    驅動程式必須呼叫 WdfRequestRetrieveInputMemory 以取得要求的輸入緩衝區句柄,而且必須使用該句柄做為 InputBuffer 的值。

  3. 針對 WdfIoTargetFormatRequestForInternalIoctl 方法的 OutputBuffer 參數,使用收到的要求輸出緩衝區。

    驅動程式必須呼叫 WdfRequestRetrieveOutputMemory 以取得要求的輸出緩衝區句柄,而且必須使用該句柄做為 OutputBuffer 的值

如需轉送 I/O 要求的詳細資訊,請參閱 轉送 I/O 要求

驅動程式通常會將收到的 I/O 要求分成較小的要求,這些要求會傳送至 I/O 目標,因此您的驅動程式可能會建立新的要求。

若要建立新的 I/O 要求:

  1. 建立新的要求物件,併為 WdfIoTargetFormatRequestForInternalIoctl 方法的 Request 參數提供其句柄。

    呼叫 WdfRequestCreate 以預先配置一或多個要求物件。 您可以呼叫 WdfRequestReuse 來重複使用這些要求物件。 驅動程式的 EvtDriverDeviceAdd 回呼函式可以預先配置裝置的要求物件。

  2. 提供緩衝區空間,併為 WdfIoTargetFormatRequestForInternalIoctl 方法的 InputBufferOutputBuffer 參數提供緩衝區的句柄。

    您的驅動程式必須將此緩衝區空間指定為 WDFMEMORY 控點,以處理架構管理的記憶體。 您的驅動程式可以執行下列其中一項:

    • 如果您想要驅動程式將新的緩衝區傳遞至 I/O 目標,請呼叫 WdfMemoryCreateWdfMemoryCreatePreallocated 來建立新的記憶體緩衝區。
    • 如果您想要讓驅動程式將該緩衝區的內容傳遞至 I/O 目標,請呼叫 WdfRequestRetrieveOutputMemory 來取得記憶體物件的句柄,代表接收的 I/O 要求的緩衝區。
    請注意,如果您的驅動程式呼叫 WdfRequestRetrieveInputMemoryWdfRequestRetrieveOutputMemory ,並將記憶體句柄傳遞至 WdfIoTargetFormatRequestForInternalIoctl,驅動程式在驅動程式刪除、重複使用或重新格式化新的驅動程式建立要求對象之後,才能完成收到的 I/O 要求。 (WdfIoTargetFormatRequestForInternalIoctl 遞增記憶體對象的參考計數。刪除、重複使用或重新格式化要求物件會遞減記憶體對象的參考計數。)
驅動程式呼叫 WdfIoTargetFormatRequestForInternalIoctl 格式化裝置控制項要求之後,驅動程式必須呼叫 WdfRequestSend ,以同步或異步) 方式將要求傳送至 I/O 目標 (。

對使用相同要求之 WdfIoTargetFormatRequestForInternalIoctl 的多個呼叫不會造成額外的資源配置。 因此,為了減少 WdfRequestCreate 將傳回STATUS_INSUFFICIENT_RESOURCES的機會,驅動程式的 EvtDriverDeviceAdd 回呼函式可以呼叫 WdfRequestCreate 來預先配置裝置的一或多個要求物件。 驅動程式接著可以重複使用 (呼叫 WdfRequestReuse) 、重新格式化 (呼叫 WdfIoTargetFormatRequestForInternalIoctl) ,然後重新傳送 (呼叫 WdfRequestSend) 每個要求物件,而不需在稍後呼叫 WdfRequestCreate 時產生STATUS_INSUFFICIENT_RESOURCES傳回值的風險。 如果參數值未變更,則針對重複使用的要求物件,對 WdfIoTargetFormatRequestForInternalIoctl 的所有後續呼叫都會傳回STATUS_SUCCESS。 不過, (,如果驅動程式每次未呼叫相同的要求格式方法,可能會配置其他資源。此外,如果 I/O 控制程式代碼 指定METHOD_BUFFERED的傳輸類型,架構必須為每個要求配置系統緩衝區,而且該配置可能會因為記憶體資源不足而失敗。)

如需 I/O 要求完成之後取得狀態資訊的相關信息,請參閱 取得完成資訊

如需 WdfIoTargetFormatRequestForInternalIoctl 的詳細資訊,請參閱 將 I/O 要求傳送至一般 I/O 目標

如需 I/O 目標的詳細資訊,請參閱 使用 I/O 目標

範例

下列程式代碼範例會建立架構記憶體物件,該物件是要求物件的子系。 接下來,此範例會取得記憶體物件包含並初始化緩衝區的緩衝區。 然後,此範例會格式化要求、設定 CompletionRoutine 回呼函式,並將要求傳送至 I/O 目標。

WDF_OBJECT_ATTRIBUTES memoryObjAttr;
WDFMEMORY memory;
NTSTATUS status;
IOCTL_DATA *pIoctlData;

WDF_OBJECT_ATTRIBUTES_INIT(&memoryObjAttr);
memoryObjAttr.ParentObject = Request;

status = WdfMemoryCreate(
                         &memoryObjAttr,
                         NonPagedPool,
                         0,
                         sizeof(IOCTL_DATA),
                         &memory,
                         NULL
                         );
if (!NT_SUCCESS(status)) {
    goto Done;
}
pIoctlData = WdfMemoryGetBuffer(
                                memory,
                                NULL
                                );
RtlZeroMemory(
              pIoctlData,
              sizeof(IOCTL_DATA)
              );
pIoctlData->Member1 = MY_DATA;

status = WdfIoTargetFormatRequestForInternalIoctl(
                                                  IoTarget,
                                                  Request,
                                                  IOCTL_INTERNAL_GET_MY_DATA,
                                                  memory,
                                                  NULL,
                                                  WDF_NO_HANDLE,
                                                  NULL
                                                  );

if (!NT_SUCCESS(status)) {
    goto Done;
}

WdfRequestSetCompletionRoutine(
                               Request,
                               MyRequestCompletion,
                               NULL
                               );

if (WdfRequestSend(
                   Request,
                   IoTarget,
                   NULL
                   ) == FALSE) {
    status = WdfRequestGetStatus(Request);
}
else {
    status = STATUS_SUCCESS;
}

規格需求

需求
目標平台 Universal
最小 KMDF 版本 1.0
標頭 wdfiotarget.h (包含 Wdf.h)
程式庫 Wdf01000.sys (請參閱 Framework Library Versioning.)
IRQL <=DISPATCH_LEVEL
DDI 合規性規則 DriverCreate (kmdf) KmdfIrql (kmdf) KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) 、 RequestFormattedValid (kmdf) RequestSendAndForgetNoFormatting (kmdf) RequestSendAndForgetNoFormatting2 (kmdf)

另請參閱

EvtDriverDeviceAdd

WDFMEMORY_OFFSET

WdfDeviceGetIoTarget

WdfIoTargetCreate

WdfIoTargetFormatRequestForIoctl

WdfIoTargetSendInternalIoctlSynchronously

WdfIoTargetSendIoctlSynchronously

WdfMemoryCreate

WdfMemoryCreatePreallocated

WdfRequestCreate

WdfRequestRetrieveInputMemory

WdfRequestRetrieveOutputMemory

WdfRequestReuse

WdfRequestSend