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

[アーティクル]
08/07/2023

ProtocolClDropPartyComplete 関数は、マルチポイント接続を設定する接続指向の NDIS クライアントによって使用されます。このようなクライアントは、開始する非同期操作を完了するために ProtocolClDropPartyComplete 関数を持っている必要があります

NdisClDropParty。それ以外の場合、このようなプロトコルドライバーの登録された ProtocolClDropPartyComplete 関数は、単に制御を返すことができます。

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

構文

PROTOCOL_CL_DROP_PARTY_COMPLETE ProtocolClDropPartyComplete;

void ProtocolClDropPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolPartyContext
)
{...}

パラメーター

[in] Status

クライアントによって開始されるドロップパーティ操作の最終的な状態を指定します。これは、次のいずれかになります。

NDIS_STATUS_SUCCESS

パーティーは削除されました。クライアントが ProtocolPartyContext 領域に格納しているこのパーティを表す NdisPartyHandle が無効になりました。

NDIS_STATUS_FAILURE

指定されたパーティは、クライアントのマルチポイント VC の最後の残りのパーティでした。そのため、クライアントは NdisClCloseCall を呼び出して、このパーティを削除する必要があります。

[in] ProtocolPartyContext

クライアントが NdisClAddParty または NdisClMakeCall を呼び出したときに最初に NDIS に提供された、クライアントのパーティごとのコンテキスト領域へのハンドルを指定します。

戻り値

なし

解説

ProtocolClDropPartyComplete の呼び出しは、呼び出しマネージャーが、NdisClDropParty に対するクライアントの以前の呼び出しによって開始された要求の処理を完了したことを示します。 ProtocolClDropPartyComplete は、クライアントによって割り当てられたパーティごとのコンテキスト領域を解放するか、 NdisClAddParty の後続の呼び出しで再利用できるように準備することができます。

クライアントが作成したマルチポイント VC を破棄している場合、ProtocolClDropPartyComplete は、有効な NdisPartyHandle を使用して NdisClDropParty をクライアントのアクティブなマルチポイント VC 上の残りのパーティの 1 つに呼び出すことができます。もう 1 つのパーティがマルチポイント VC に残っている場合、クライアントは NdisPartyHandle を NdisClCloseCall に渡して、そのパーティを削除する必要があります。

例

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

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

PROTOCOL_CL_DROP_PARTY_COMPLETE MyClDropPartyComplete;

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

_Use_decl_annotations_
VOID
 MyClDropPartyComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolPartyContext
    )
  {...}

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

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

要件

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