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

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

ProtocolCoDeleteVc 関数が必要です。この関数は、その VC の元の作成者によって閉じられている確立された仮想接続のクライアントまたは呼び出しマネージャーの状態を破棄します。

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

構文

PROTOCOL_CO_DELETE_VC ProtocolCoDeleteVc;

NDIS_STATUS ProtocolCoDeleteVc(
  [in] NDIS_HANDLE ProtocolVcContext
)
{...}

パラメーター

[in] ProtocolVcContext

クライアントまたは呼び出しマネージャーの VC ごとのコンテキスト領域へのハンドルを指定します。プロトコルは、もともと ProtocolCoCreateVc 関数からこのハンドルを提供しました。

戻り値

ProtocolCoDeleteVc は 、次のいずれかを返すことができます。

リターンコード	説明
NDIS_STATUS_SUCCESS	プロトコルは、最初に VC に割り当てたすべてのリソースを解放または再利用する準備を整えました。
NDIS_STATUS_NOT_ACCEPTED	VC はまだアクティブであり、プロトコルには VC で保留中の未処理の操作があるため、破棄できません。
NDIS_STATUS_XXX	プロトコルは、ドライバーによって決定された理由で VC の削除に失敗しました。

注釈

ProtocolCoDeleteVc は、ドライバーの ProtocolCoCreateVc 関数の逆数です。一般に、呼び出しマネージャーまたはクライアントがアクティブ VC に対して操作を実行するために以前に割り当てた動的リソースと構造体を解放します。

ProtocolCoDeleteVc が NDIS_STATUS_SUCCESSを持つコントロールを返すと、ProtocolVcContext の領域に格納されている ProtocolCoCreateVc 関数が無効になる NdisVcHandle。

ProtocolCoDeleteVc は、ドライバーによって決定されたNDIS_STATUS_XXX を返して VC の削除を失敗させることができますが、NDIS_STATUS_PENDINGを返すことはできません。 ProtocolCoDeleteVc の呼び出しは本質的に同期的です。

例

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

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

PROTOCOL_CO_DELETE_VC MyCoDeleteVc;

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

_Use_decl_annotations_
NDIS_STATUS
 MyCoDeleteVc(
    NDIS_HANDLE  ProtocolVcContext
    )
  {...}

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

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

要件

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