PROTOCOL_CL_NOTIFY_CLOSE_AF回呼函式 (ndis.h)

發行項
03/05/2024

ProtocolClNotifyCloseAf 函式會通知 CoNDIS 用戶端，客戶端應該關閉相關聯的位址系列 (AF) 。

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

語法

PROTOCOL_CL_NOTIFY_CLOSE_AF ProtocolClNotifyCloseAf;

NDIS_STATUS ProtocolClNotifyCloseAf(
  [in] NDIS_HANDLE ClientAfContext
)
{...}

參數

[in] ClientAfContext

用戶端為其相關 AF 的內容區域提供句柄。用戶端已配置此內容區域，並在其呼叫中將此句柄傳遞至 NDIS NdisClOpenAddressFamilyEx 函式。

傳回值

ProtocolClNotifyCloseAf 可以傳回下列其中一項：

傳回碼	Description
NDIS_STATUS_SUCCESS	用戶端已成功關閉位址系列。
NDIS_STATUS_PENDING	用戶端會以異步方式處理此要求，而且會呼叫當關閉作業完成時，NdisClNotifyCloseAddressFamilyComplete 函式。
NDIS_STATUS_XXX	用戶端因為某些驅動程序決定的原因而失敗要求。

備註

TheCoNDIS 用戶端需要 ProtocolClNotifyCloseAf 函式。當呼叫管理員通知 NDIS 位址系列 (AF) 應關閉 ProtocolAfContext 參數時，NDIS 會呼叫 ProtocolClNotifyCloseAf。回應中，客戶端應該：

視需要呼叫 NdisClDropParty 函式，直到只有單一合作物件在每一個多點虛擬連線上保持作用中 (VC) ，如果用戶端有任何作用中的多點連線。
視需要呼叫 NdisCloseCall 函式，以關閉所有仍在開啟且與 AF 相關聯的呼叫。
視需要呼叫 NdisClDeregisterSap 函式，以取消註冊所有服務存取點， (SAN) 用戶端向呼叫管理員註冊。
呼叫 NdisCloseAddressFamily 函式以關閉 AF。

用戶端可以傳回NDIS_STATUS_PENDING，以異步方式完成這些動作。如果客戶端以異步方式完成呼叫，則後續必須呼叫當關閉作業完成時，NdisClNotifyCloseAddressFamilyComplete 函式。如果用戶端未傳回NDIS_STATUS_PENDING，當關閉作業完成時 ProtocolClNotifyCloseAf 會傳回。

NDIS 會在 IRQL <= DISPATCH_LEVEL 呼叫 ProtocolClNotifyCloseAf。

當 AF 開啟或開啟時，用戶端可以使用 NdisAfHandle ProtocolClNotifyCloseAf 作業擱置中。如果裝置上無法使用 ProtocolClNotifyCloseAf 函式會傳回NDIS_STATUS_PENDING，請使用中的句柄關閉作業完成之後，NdisClNotifyCloseAddressFamilyComplete 呼叫。

例子

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

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

PROTOCOL_CL_NOTIFY_CLOSE_AF MyClNotifyCloseAf;

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

_Use_decl_annotations_
NDIS_STATUS
 MyClNotifyCloseAf(
    NDIS_HANDLE  ProtocolAfContext
    )
  {...}

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

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