PROTOCOL_CL_CLOSE_CALL_COMPLETE回呼函式 (ndis.h)

發行項
02/26/2024

ProtocolCloseCallComplete 函式是由連接導向的 NDIS 用戶端使用。所有連線導向的 NDIS 用戶端都必須具有 ProtocolCloseCallComplete 函式，才能完成其起始的異步操作

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

語法

PROTOCOL_CL_CLOSE_CALL_COMPLETE ProtocolClCloseCallComplete;

void ProtocolClCloseCallComplete(
  [in]           NDIS_STATUS Status,
  [in]           NDIS_HANDLE ProtocolVcContext,
  [in, optional] NDIS_HANDLE ProtocolPartyContext
)
{...}

參數

[in] Status

指定要關閉此呼叫之用戶端要求的最終狀態，這可以是下列其中一項：

NDIS_STATUS_SUCCESS

呼叫管理員已成功關閉存在於指定 VC 上的呼叫，並停用 VC。

NDIS_STATUS_XXX

呼叫管理員無法關閉某些 CM 判斷原因的呼叫，而 NDIS 會將其 ProtocolCmCloseCall 函式傳回的狀態傳播至用戶端。

[in] ProtocolVcContext

指定用戶端每個 VC 內容區域的句柄這是用戶端原本使用 NdisCoCreateVc 傳遞至 NDIS 的句柄，或從其 ProtocolCoCreateVc 函式傳回至 NDIS。

[in, optional] ProtocolPartyContext

針對代表多點連線之用戶端建立的 VC 上最後一方，指定用戶端每一方內容區域的句柄。否則，此參數為 NULL。

傳回值

無

備註

如果指定的 VC 是由用戶端所建立，且狀態為NDIS_STATUS_SUCCESS，則客戶端現在可以執行下列其中一項：

使用 NdisCoDeleteVc 卸除其 VC，並釋出或準備重複使用其所配置的內容區域 () 。
重新初始化其每個 VC 內容區域，並重複使用其 VC，以與 NdisClMakeCall 建立另一個連線。

如果 VC 是由呼叫管理員所建立，當呼叫 ProtocolCloseCallComplete 時，客戶端應該考慮 NdisVcHandle 無效。用戶端不得使用此 NdisVcHandle 進行任何進一步的 NdisCl/CoXxx 呼叫。 ProtocolCloseCallComplete 傳回控制權之後，呼叫管理員可以刪除其 VC，因而導致呼叫用戶端的 ProtocolCoDeleteVc 函式。呼叫管理員甚至可以在建立的 VC 上分派另一個連入呼叫，因而導致對用戶端的呼叫 ProtocolClIncomingCall 函式。

例子

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

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

PROTOCOL_CL_CLOSE_CALL_COMPLETE MyClCloseCallComplete;

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

_Use_decl_annotations_
VOID
 MyClCloseCallComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolVcContext,
    NDIS_HANDLE  ProtocolPartyContext
    )
  {...}

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

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

規格需求

需求	值
最低支援的用戶端	支援 NDIS 6.0 和 NDIS 5.1 驅動程式 (請參閱 Windows Vista 中的 ProtocolCloseCallComplete (NDIS 5.1) ) 。支援 NDIS 5.1 驅動程式 (請參閱 Windows XP 中的 ProtocolCloseCallComplete (NDIS 5.1) ) 。
目標平台	Windows
標頭	ndis.h (包括 Ndis.h)
IRQL	<= DISPATCH_LEVEL