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

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

ProtocolClIncomingDropParty 関数は、マルチポイント接続を設定する接続指向の NDIS クライアントによって使用されます。このようなクライアントには 、ProtocolClIncomingDropParty 関数が必要です 。それ以外の場合、このようなプロトコルドライバーの登録された ProtocolClIncomingDropParty 関数は、単に制御を返すことができます。

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

構文

PROTOCOL_CL_INCOMING_DROP_PARTY ProtocolClIncomingDropParty;

void ProtocolClIncomingDropParty(
  [in] NDIS_STATUS DropStatus,
  [in] NDIS_HANDLE ProtocolPartyContext,
  [in] PVOID CloseData,
  [in] UINT Size
)
{...}

パラメーター

[in] DropStatus

パーティが削除される理由を示します。通常、これは、リモートノート上のパーティが接続の終了を開始した場合にNDIS_STATUS_SUCCESSされますが、検出されたネットワークの問題のためにコールマネージャーがこのドロップパーティ操作を開始した場合は、CM によって決定された状態になる可能性があります。

[in] ProtocolPartyContext

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

[in] CloseData

プロトコル固有のクローズメッセージを含むバッファーへのポインター。場合によっては、呼び出しマネージャーがネットワーク経由で受信したリモートクライアントによって提供されるメッセージ、またはこのパラメーターに NULL を指定できます。

DropStatus がNDIS_STATUS_SUCCESSされている場合、基になるネットワークメディアが接続を閉じるときにデータの転送をサポートしていない場合、このパラメーターは NULL になります。ただし、特定の呼び出しマネージャーは、ネットワーク上の問題によって引き起こされるドロップパーティ操作で追加の診断情報をクライアントに渡す構造を定義する場合があります。

[in] Size

CloseData が NULL の場合は、CloseData のバッファーの長さをバイト単位で指定します。

戻り値

なし

解説

ProtocolClIncomingDropParty の呼び出しは、次のいずれかが発生したことを示します。

呼び出しマネージャーは、クライアントが ProtocolPartyContext のパーティごとのコンテキスト領域に格納した NdisPartyHandle によって識別される、確立された接続を閉じる要求をネットワーク経由で受信しました。
呼び出しマネージャーは、ネットワークの問題により、確立された接続でのそれ以上のデータ転送が妨げられることを検出しました。

どちらの場合も、 ProtocolClIncomingDropParty は、クライアントのマルチポイント VC からパーティを削除するためのプロトコルによって決定された操作を実行する必要があります。 ProtocolClIncomingDropParty は NdisClDropParty を呼び出す必要があります。または、これがクライアントのマルチポイント VC の最後の残りのパーティである場合は NdisClCloseCall を呼び出す必要があります。

ProtocolClIncomingDropParty は、クライアントが NdisClAddParty または NdisClMakeCall から取得した NdisPartyHandle が無効であると見なす必要があります。 ProtocolClIncomingDropParty は、クライアントのパーティごとのコンテキスト領域を解放するか、 NdisClAddParty への後続の呼び出しで再利用できるように準備することができます。

例

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

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

PROTOCOL_CL_INCOMING_DROP_PARTY MyClIncomingDropParty;

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

_Use_decl_annotations_
VOID
 MyClIncomingDropParty(
    NDIS_STATUS  DropStatus,
    NDIS_HANDLE  ProtocolPartyContext,
    PVOID  CloseData,
    UINT  Size
    )
  {...}

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

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

要件

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