PROTOCOL_CL_DROP_PARTY_COMPLETE回呼函式 (ndis.h)

發行項
02/29/2024

ProtocolClDropPartyComplete 函式是由設定多點連線的連接導向 NDIS 用戶端使用。這類客戶端必須具有 ProtocolClDropPartyComplete 函式，才能完成其起始的異步操作

NdisClDropParty。否則，這類通訊協定驅動程式的已註冊 ProtocolClDropPartyComplete 函式可以直接傳回控制權。

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

語法

PROTOCOL_CL_DROP_PARTY_COMPLETE ProtocolClDropPartyComplete;

void ProtocolClDropPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolPartyContext
)
{...}

參數

[in] Status

指定用戶端起始的卸除合作物件作業的最終狀態，可以是下列其中一項：

NDIS_STATUS_SUCCESS

已卸除合作物件。代表此合作物件的 NdisPartyHandle ，用戶端儲存在其 ProtocolPartyContext 區域中，現在無效。

NDIS_STATUS_FAILURE

指定的合作對像是用戶端多點 VC 的最後一個剩餘專案。因此，客戶端應該呼叫 NdisCloseCall 來卸除此合作物件。

[in] ProtocolPartyContext

指定用戶端個別內容區域的句柄，用戶端最初在呼叫 NdisClAddParty 或 NdisClMakeCall 時提供給 NDIS。

傳回值

無

備註

對 ProtocolClDropPartyComplete 的呼叫表示呼叫管理員已完成用戶端先前呼叫 NdisClDropParty 所起始的要求處理。 ProtocolClDropPartyComplete 可以釋放用戶端配置的個別合作對象內容區域，或準備在 後續呼叫 NdisClAddParty 時重複使用。

如果用戶端正在卸除其建立的多點 VC，ProtocolClDropPartyComplete 可以使用任何有效的 NdisPartyHandle 呼叫 NdisClDropParty，給用戶端作用中多點 VC 上的其中一個剩餘合作物件。如果只有一方保留在其多點 VC 上，客戶端應該將 NdisPartyHandle 傳遞給 NdisCloseCall 來卸載該合作物件。

例子

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

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

PROTOCOL_CL_DROP_PARTY_COMPLETE MyClDropPartyComplete;

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

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

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

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

規格需求

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