PROTOCOL_CL_CLOSE_AF_COMPLETE コールバック関数 (ndis.h)

[アーティクル]
02/29/2024

ProtocolClCloseAfComplete 関数は、接続指向 NDIS クライアントで使用されます。 NdisClCloseAddressFamily で開始する非同期操作を完了するには、すべての接続指向 NDIS クライアントに ProtocolClCloseAfComplete 関数が必要です。

メモPROTOCOL_CL_CLOSE_AF_COMPLETE型を使用して関数を宣言する必要があります。詳細については、次の例に関するセクションを参照してください。

構文

PROTOCOL_CL_CLOSE_AF_COMPLETE ProtocolClCloseAfComplete;

void ProtocolClCloseAfComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolAfContext
)
{...}

パラメーター

[in] Status

アドレスファミリを閉じるクライアントによって開始される要求の最終的な状態を指定します。これは、次のいずれかになります。

NDIS_STATUS_SUCCESS

住所ファミリが閉じられました。 クライアントが ProtocolAfContext 領域に格納しているオープンアドレスファミリを表す NdisAfHandle が無効になりました。

NDIS_STATUS_FAILURE

AF を閉じる前にクライアントが解放する必要がある VC または登録済みの SAP が AF に関連付けられているか、または NDIS が AF 状態が "終了" としてマークされたことが検出されたため、 NdisClCloseAddressFamily というクライアントが 2 回関連付けられています。

[in] ProtocolAfContext

AF ごとのコンテキスト領域に対するクライアント指定のハンドルを指定します。クライアントは、最初にこのコンテキスト領域を設定し、 NdisClOpenAddressFamilyEx を使用して NDIS にこのハンドルを渡しました。

戻り値

なし

解説

未処理の VC や登録済みの SAP がオープンアドレスファミリにないことを確認した後、クライアントは NdisClCloseAddressFamily を呼び出して、それ自体、呼び出しマネージャー、および特定の基になる NIC との間の関連付けを削除します。 NDIS は、このクライアントが最初に非同期操作としてアドレスファミリを開くために使用した呼び出しマネージャーの ProtocolCmCloseAf 関数を呼び出します。 NdisClCloseAddressFamily を呼び出した後、クライアントは NdisAfHandle が無効であると見なす必要があります。

そのため、クライアントには ProtocolClCloseAfComplete 関数が必要です。この関数は、非同期の close-AF 操作が完了したときに NDIS によって呼び出されます。入力状態がNDIS_STATUS_SUCCESS場合、クライアントは AF ごとのコンテキスト領域を解放できます。

例

ProtocolClCloseAfComplete 関数を定義するには、まず、定義する関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数型のセットが用意されています。関数の種類を使用して関数を宣言すると、ドライバーのコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティングシステム用のドライバーを記述するための要件になります。

たとえば、" MyClCloseAfComplete" という名前の ProtocolClCloseAfComplete 関数を定義するには、次のコード例に示すように 、PROTOCOL_CL_CLOSE_AF_COMPLETE 型を使用します。

PROTOCOL_CL_CLOSE_AF_COMPLETE MyClCloseAfComplete;

次に、次のように関数を実装します。

_Use_decl_annotations_
VOID
 MyClCloseAfComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolAfContext
    )
  {...}

PROTOCOL_CL_CLOSE_AF_COMPLETE関数の種類は、Ndis.h ヘッダーファイルで定義されています。コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダーファイル内のPROTOCOL_CL_CLOSE_AF_COMPLETE関数型に適用される注釈が確実に使用されます。関数宣言の要件の詳細については、「NDIS ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。

Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows Vista の NDIS 6.0 および NDIS 5.1 ドライバー (「ProtocolClCloseAfComplete (NDIS 5.1)」を参照) でサポートされています。 Windows XP の NDIS 5.1 ドライバー (「ProtocolClCloseAfComplete (NDIS 5.1)」を参照) でサポートされています。
対象プラットフォーム	Windows
ヘッダー	ndis.h (Ndis.h を含む)
IRQL	<= DISPATCH_LEVEL