PROTOCOL_CM_DEREGISTER_SAP コールバック関数 (ndis.h)
ProtocolCmDeregisterSap 関数が必要です。 この関数は NDIS によって呼び出され、呼び出しマネージャーが接続指向クライアントに代わって SAP の登録を解除するように要求します。
構文
PROTOCOL_CM_DEREGISTER_SAP ProtocolCmDeregisterSap;
NDIS_STATUS ProtocolCmDeregisterSap(
[in] NDIS_HANDLE CallMgrSapContext
)
{...}
パラメーター
[in] CallMgrSapContext
呼び出しマネージャーが SAP ごとの状態情報を保持する、呼び出しマネージャーによって割り当てられたコンテキスト領域へのハンドルを指定します。 呼び出しマネージャーは、 から NDIS にこのハンドルを提供しました。 ProtocolCmRegisterSap 関数。
戻り値
ProtocolCmDeregisterSap は、その操作の状態を次のいずれかとして返します。
リターン コード | 説明 |
---|---|
|
呼び出しマネージャーが SAP 登録を正常に削除し、SAP ごとの情報を維持するために割り当てられたすべてのリソースを解放したことを示します。 |
|
呼び出しマネージャーが SAP を非同期的に登録解除する要求を完了することを示します。 呼び出しマネージャーは、 を呼び出す必要があります操作が完了したときに NDIS を通知する NdisCmDeregisterSapComplete。 |
注釈
ProtocolCmDeregisterSap は、必要に応じてネットワーク制御デバイスまたはその他のメディア固有のエージェントと通信して、ネットワーク上の SAP を登録解除します。 このようなアクションには、次のものが含まれますが、これらに限定されません。
- スイッチング ハードウェアとの通信
- ネットワーク制御ステーションとの通信
- 他のメディア固有のネットワーク エージェントとの通信
さらに、 ProtocolCmDeregisterSap は 、CallMgrSapContext で提供される SAP 領域ごとに動的に割り当てられたリソースを解放し、NDIS に制御を返す前に状態領域自体を解放する必要があります。
例
ProtocolCmDeregisterSap 関数を定義するには、まず、定義する関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数型のセットが用意されています。 関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。たとえば、" MyCmDeregisterSap" という名前の ProtocolCmDeregisterSap 関数を定義するには、次のコード例に示すように 、PROTOCOL_CM_DEREGISTER_SAP 型を使用します。
PROTOCOL_CM_DEREGISTER_SAP MyCmDeregisterSap;
次に、次のように関数を実装します。
_Use_decl_annotations_
NDIS_STATUS
MyCmDeregisterSap(
NDIS_HANDLE CallMgrSapContext
)
{...}
PROTOCOL_CM_DEREGISTER_SAP関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のPROTOCOL_CM_DEREGISTER_SAP関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。
Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista の NDIS 6.0 および NDIS 5.1 ドライバー (「ProtocolCmDeregisterSap (NDIS 5.1)」を参照) でサポートされています。 Windows XP の NDIS 5.1 ドライバー (「ProtocolCmDeregisterSap (NDIS 5.1)」を参照) でサポートされています。 |
対象プラットフォーム | Windows |
ヘッダー | ndis.h (Ndis.h を含む) |
IRQL | <= DISPATCH_LEVEL |