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

  • [アーティクル]

ProtocolCmCloseAf 関数は、呼び出しマネージャーがサポートするアドレス ファミリの開いているリソースごとに解放する必須の関数です。

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

構文

PROTOCOL_CM_CLOSE_AF ProtocolCmCloseAf;

NDIS_STATUS ProtocolCmCloseAf(
  [in] NDIS_HANDLE CallMgrAfContext
)
{...}

パラメーター

[in] CallMgrAfContext

呼び出しマネージャーの ProtocolCmOpenAf 関数によって NDIS に最初に指定された、呼び出しマネージャーの AF ごとのコンテキスト領域へのハンドルを指定します。

戻り値

ProtocolCmCloseAf は、次のいずれかの操作の状態を返します。

リターン コード 説明
NDIS_STATUS_SUCCESS
 アドレス ファミリのこのインスタンスを開いた接続指向クライアントの代わりに割り当てられたリソースが、呼び出しマネージャーによって正常に解放または非アクティブ化されたことを示します。
NDIS_STATUS_PENDING
 アドレス ファミリの開いているインスタンスを閉じる要求が非同期的に完了することを示します。 呼び出しマネージャーは、 を呼び出す必要がありますこのようなすべての操作が完了した場合の NdisCmCloseAddressFamilyComplete。

注釈

ProtocolCmCloseAf は、 ProtocolCmOpenAf 関数で呼び出しマネージャーによって割り当てられたリソースを解放または非アクティブ化します。 また、通話マネージャーは、そのクライアントによってアドレス ファミリが開かれたときに、接続指向クライアントに代わって実行されたその他のアクションも元に戻す必要があります。

CallMgrAfContext に格納されているアドレス ファミリで未処理の要求または接続がまだ開いている場合、通話マネージャーは、次のいずれかの方法でアドレス ファミリを閉じるクライアントの要求に応答できます。

  • 呼び出しマネージャーは、NDIS_STATUS_NOT_ACCEPTEDを使用して要求を失敗させることができます。
  • 呼び出しマネージャーは、NDIS_STATUS_PENDINGを返すことができます。 クライアントがすべての呼び出しを閉じ、すべての SAP を登録解除した後、通話マネージャーはアドレス ファミリを閉じて NdisCmCloseAddressFamilyComplete または を呼び出すことができます。 クライアントに通知する NdisMCmCloseAddressFamilyComplete 。 これが推奨される応答です。

例

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

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

PROTOCOL_CM_CLOSE_AF MyCmCloseAf;

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

_Use_decl_annotations_
NDIS_STATUS
 MyCmCloseAf(
    NDIS_HANDLE  CallMgrAfContext
    )
  {...}

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

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

要件

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

こちらもご覧ください

NdisCmCloseAddressFamilyComplete

ProtocolCmOpenAf