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

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

ProtocolClAddPartyComplete 関数は、マルチポイント接続を設定する接続指向 NDIS クライアントに必要です。このようなクライアントは、 NdisClAddParty で開始する非同期操作を完了するために ProtocolClAddPartyComplete 関数を持っている必要があります。それ以外の場合、このようなプロトコルドライバーの登録された ProtocolClAddPartyComplete 関数は、単に制御を返すことができます。

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

構文

PROTOCOL_CL_ADD_PARTY_COMPLETE ProtocolClAddPartyComplete;

void ProtocolClAddPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolPartyContext,
  [in] NDIS_HANDLE NdisPartyHandle,
  [in] PCO_CALL_PARAMETERS CallParameters
)
{...}

パラメーター

[in] Status

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

NDIS_STATUS_SUCCESS

指定されたパーティは、クライアントのアクティブなマルチポイント VC に追加されました。

NDIS_STATUS_RESOURCES

NDIS では、新しいパーティを追跡するための十分なリソースを割り当てませんでした。

NDIS_STATUS_FAILURE

クライアントが無効な NdisVcHandle を NdisClAddParty に渡しました。

NDIS_STATUS_XXX

呼び出しマネージャーの ProtocolCmAddParty 関数は、VC にパーティを追加できない理由を示す CM によって決定された値を返しました。

[in] ProtocolPartyContext

最初に NdisClAddParty に渡されたクライアント指定のハンドルを指定します。

[in] NdisPartyHandle

Status がNDIS_STATUS_SUCCESS場合、この NDIS 提供のハンドルは、このパーティに関する呼び出しマネージャーとクライアント間の関連付けを表します。それ以外の場合、パーティを追加しようとして失敗し、クライアントはこのパラメーターを無効なハンドルと見なす必要があります。

[in] CallParameters

型 CO_CALL_PARAMETERSの構造体へのポインター。最初は NdisClAddParty の呼び出しのためにクライアントによって設定されますが、呼び出しマネージャーによって後で変更される可能性があります。

戻り値

なし

解説

ProtocolClAddPartyComplete の呼び出しは、クライアントが NdisClAddParty を呼び出したときに開始される非同期操作の完了を示します。入力状態がNDIS_STATUS_SUCCESS以外に設定されている場合、 ProtocolClAddPartyComplete は ProtocolPartyContext および CallParameters でクライアント割り当てバッファーを解放または再利用できます。

パーティの追加が成功した場合、 ProtocolClAddPartyComplete は、クライアントの ProtocolPartyContext 領域で、このパーティに関する NDIS ライブラリ関数の後続の呼び出しのために、入力 NdisPartyHandle を 保存する必要があります。たとえば、クライアントは、そのハンドルを表すリモートパーティが最初に接続を閉じなければ、最終的に NdisClDropParty への後続の呼び出しでこのハンドルを渡す必要があります。

CallParameters の構造体は、最初にクライアントによって割り当てられ、初期化され、このポインターがに渡されました
NdisClAddParty。ただし、呼び出しマネージャーは、クライアントのアドイン要求の処理中に、ネットワークまたはシグナリングピアとの CM のネゴシエーションの結果を反映するように、クライアントが指定した値を変更した可能性があります。呼び出しマネージャーが変更を加えたかどうかを判断するために、ProtocolClAddPartyComplete は、この構造体の Flags メンバーをチェックして、CALL_PARAMETERS_CHANGEDが設定されているかどうかを確認できます。その場合、 ProtocolClAddPartyComplete は、CM の変更が受け入れられないと判断されない限り 、ProtocolPartyContext でのこの呼び出しに対してクライアントが保持するパーティごとの状態を更新する必要があります。この場合、クライアントが実行できる操作は、特定のシグナリングプロトコルによって決まります。通常、CM で変更された呼び出しパラメーターが受け入れられないと検出された場合、クライアントは NdisClDropParty を呼び出します。

呼び出しマネージャーのシグナリングプロトコルに応じて、 CallParameters のトラフィックパラメーターは、特定のマルチポイント接続上のすべての関係者で同一にすることができます。つまり、このような呼び出しマネージャーのクライアントは、クライアントが最初に NdisClMakeCall で設定したマルチポイント接続にパーティを追加すると、各パーティのターゲットアドレスのみを指定し、 NdisClAddParty を呼び出すたびにトラフィックパラメーターを最初にマルチポイント VC 用に設定したままにすることができます。

例

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

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

PROTOCOL_CL_ADD_PARTY_COMPLETE MyClAddPartyComplete;

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

_Use_decl_annotations_
VOID
 MyClAddPartyComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolPartyContext,
    NDIS_HANDLE  NdisPartyHandle,
    PCO_CALL_PARAMETERS  CallParameters
    )
  {...}

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

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

要件

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