PROTOCOL_OID_REQUEST_COMPLETE回呼函式 (ndis.h)

發行項
02/29/2024

ProtocolOidRequestComplete 函式會完成通訊協定驅動程式起始的 OID 要求的處理，NdisOidRequest 函式會傳回NDIS_STATUS_PENDING。

注意您必須使用 PROTOCOL_OID_REQUEST_COMPLETE 類型來宣告函式。如需詳細資訊，請參閱下列範例一節。

語法

PROTOCOL_OID_REQUEST_COMPLETE ProtocolOidRequestComplete;

void ProtocolOidRequestComplete(
  [in] NDIS_HANDLE ProtocolBindingContext,
  [in] PNDIS_OID_REQUEST OidRequest,
  [in] NDIS_STATUS Status
)
{...}

參數

[in] ProtocolBindingContext

通訊協定驅動程式配置的內容區域的句柄，通訊協定驅動程式會維護每個系結運行時間狀態。驅動程式在呼叫 NdisOpenAdapterEx 函式時提供此句柄。

[in] OidRequest

先前傳遞至 NdisOidRequest 函式的通訊協定驅動程式NDIS_OID_REQUEST結構的指標。

[in] Status

要求的最終狀態。基礎驅動程式或 NDIS 會決定此最終狀態。此參數會決定 ProtocolOidRequestComplete 與 OidRequest 的資訊有何用途。

傳回值

無

備註

ProtocolOidRequestComplete 使用 Status 的輸入值，如下所示：

如果 Status 是NDIS_STATUS_SUCCESS，則 NDIS_OID_REQUEST 結構的 BytesRead 或 BytesWritten 成員已由 NDIS 或基礎驅動程式設定，以指定從 InformationBuffer 緩衝區傳送至設定作業中 NIC 的通訊協定驅動程式提供的資訊量，或資訊Buffer 回應查詢作業傳回多少資訊。
如果通訊協定驅動程式進行查詢， ProtocolOidRequestComplete 可以使用通訊協定驅動程式所決定的任何方式在 InformationBuffer 傳回的數據，視 Oid 成員的值而定。

例如，如果通訊協定驅動程式最初起始了 OID_GEN_MAXIMUM_SEND_PACKETS 查詢時， ProtocolOidRequestComplete 可能會在 ProtocolBindingContext 區域中設定狀態變數，以節流驅動程式將針對 NdisSendNetBufferLIsts 函式的後續呼叫設定未處理的傳送數目。
如果 Status 是NDIS_STATUS_INVALID_LENGTH或 NDIS_STATUS_BUFFER_TOO_SHORT，BytesNeeded 成員會指定執行要求作業所需的 InformationBufferLength 成員的 OID 特定值。
在這些情況下， ProtocolOidRequestComplete 可以配置足夠的緩衝區空間給要求、使用所需的 InformationBufferLength 和相同的 Oid 設定另一個NDIS_OID_REQUEST結構，然後重試對 NdisOidRequest 函式的呼叫。

ProtocolOidRequestComplete 可以重試某些其他NDIS_STATUS_ XXX 自變數的要求，如 NdisOidRequest 函式的參考中所述。
如果 Status 是無法復原錯誤的NDIS_STATUS_ XXX 值， ProtocolOidRequestComplete 應該釋放配置給NDIS_OID_REQUEST結構的記憶體，並判斷驅動程式是否應該關閉系結，或調整其系結特定狀態資訊來處理系結上的持續網路 I/O 作業。

針對全域查詢和設定，基礎無連線迷你埠驅動程式對 NdisMOidRequestComplete 函式的呼叫會導致 NDIS 呼叫 ProtocolOidRequestComplete 函式。 NDIS 會將傳遞至 NdisMOidRequestComplete 的迷你埠驅動程式決定狀態轉送為 ProtocolOidRequestComplete 的輸入狀態。

針對系結特定的查詢，NDIS 會呼叫 ProtocolOidRequestComplete 函式本身。由於 NDIS 連結庫會維護所有迷你埠驅動程式的系結，因此 NDIS 只能傳回將媒體類型回報為系統提供篩選連結庫之基礎驅動程式的系結特定資訊。 NDIS 會針對通訊協定驅動程式起始的系結特定查詢傳回NDIS_STATUS_NOT_SUPPORTED給其他迷你埠驅動程式。

如需系統定義 OID 的詳細資訊，請參閱 NDIS OID。

ProtocolOidRequestComplete 可以在通訊協定驅動程式有時間檢查 NdisOidRequest 在 Status 傳回的狀態代碼之前呼叫。

NDIS 會在 IRQL <= DISPATCH_LEVEL呼叫 ProtocolOidRequestComplete。

例子

若要定義 ProtocolOidRequestComplete 函式，您必須先提供函式宣告來識別您要定義的函式類型。 Windows 提供一組驅動程式的函式類型。使用函式類型宣告函式有助於驅動程式的程式代碼分析、靜態驅動程序驗證器 (SDV) ，以及其他驗證工具會尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為「 MyOidRequestComplete」的 ProtocolOidRequestComplete 函式，請使用 PROTOCOL_OID_REQUEST_COMPLETE 類型，如下列程式代碼範例所示：

PROTOCOL_OID_REQUEST_COMPLETE MyOidRequestComplete;

然後，實作您的函式，如下所示：

_Use_decl_annotations_
VOID
 MyOidRequestComplete(
    NDIS_HANDLE  ProtocolBindingContext,
    PNDIS_OID_REQUEST  OidRequest,
    NDIS_STATUS  Status
    )
  {...}

PROTOCOL_OID_REQUEST_COMPLETE函式類型定義於 Ndis.h 頭檔中。若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 Use_decl_annotations 註釋新增至函式定義。 Use_decl_annotations註釋可確保使用頭檔中套用至PROTOCOL_OID_REQUEST_COMPLETE函式類型的批註。如需函式宣告需求的詳細資訊，請參閱使用 NDIS 驅動程式的函式角色類型來宣告函式。

如需 Use_decl_annotations的詳細資訊，請參閱標註函式行為。