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

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

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

NdisClCloseCall。

メモ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 がクライアントによって作成され 、Status がNDIS_STATUS_SUCCESS場合、クライアントは次のいずれかを実行できるようになりました。

NdisCoDeleteVc を使用して VC を破棄し、割り当てられたコンテキスト領域を解放または再利用する準備をします。
VC ごとのコンテキスト領域を再初期化し、その VC を再利用して NdisClMakeCall との別の接続を確立します。

VC が呼び出しマネージャーによって作成された場合、ProtocolClCloseCallComplete が呼び出されたときに、クライアントは NdisVcHandle を無効と見なす必要があります。クライアントは、この NdisVcHandle を使用してそれ以上 NdisCl/CoXxx 呼び出しを行う必要はありません。 ProtocolClCloseCallComplete が制御を返した後、呼び出しマネージャーはその VC を削除できるため、クライアントの ProtocolCoDeleteVc 関数の呼び出しが発生します。呼び出しマネージャーは、作成した VC に別の着信呼び出しをディスパッチできるため、クライアントの ProtocolClIncomingCall 関数。

例

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

たとえば、" MyClCloseCallComplete" という名前の ProtocolClCloseCallComplete 関数を定義するには、次のコード例に示すように 、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の詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

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