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

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

ProtocolClMakeCallComplete 関数は、発信呼び出しを行う接続指向 NDIS クライアントによって使用されます。このようなクライアントは、 NdisClMakeCall で 開始する非同期操作を完了するために ProtocolClMakeCallComplete 関数を持っている必要があります。それ以外の場合、このようなプロトコルドライバーの登録された ProtocolClMakeCallComplete 関数は、単に制御を返すことができます。

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

構文

PROTOCOL_CL_MAKE_CALL_COMPLETE ProtocolClMakeCallComplete;

void ProtocolClMakeCallComplete(
  [in]           NDIS_STATUS Status,
  [in]           NDIS_HANDLE ProtocolVcContext,
  [in, optional] NDIS_HANDLE NdisPartyHandle,
  [in]           PCO_CALL_PARAMETERS CallParameters
)
{...}

パラメーター

[in] Status

NdisClMakeCall に対するクライアントの元の呼び出しの最終的な状態を指定します。これは、次のいずれかになります。

NDIS_STATUS_SUCCESS

クライアントが仮想接続を設定しようとしましたが、成功しました。その結果、クライアントは、クライアントが ProtocolVcContext の VC ごとのコンテキスト領域に格納している NdisCoCreateVc によって返される NdisVcHandle を使用して、アクティブな VC で転送を行うことができます。

NDIS_STATUS_RESOURCES

NDIS、呼び出しマネージャー、または基になるドライバーは、接続を設定するのに十分なリソースを割り当てませんでした。

NDIS_STATUS_XXX

呼び出しマネージャーまたは基になるミニポートドライバーがアクティブな接続を確立できませんでした。NDIS は、このドライバーによって決定されたエラー状態をクライアントに伝達しました。

[in] ProtocolVcContext

クライアントの VC ごとのコンテキスト領域へのハンドルを指定します。この領域は、クライアントが NdisCoCreateVc を呼び出したときに最初に NDIS に提供され、発信呼び出し用に VC を設定します。

[in, optional] NdisPartyHandle

Status がNDIS_STATUS_SUCCESSされ、クライアントが明示的な ProtocolPartyContext ハンドルを NdisClMakeCall に渡してマルチポイント VC を作成した場合、これは有効な NdisPartyHandle です。それ以外の場合、このパラメーターは NULL です。

ProtocolClMakeCallComplete は、有効な入力 NdisPartyHandle (通常はクライアントのパーティごとのコンテキスト領域) を保存する必要があります。クライアントは、このパーティを参照する NdisClDropParty または NdisClCloseCall に対して後続の呼び出しを行う場合 (またはいつ) にこのハンドルを使用する必要があります。

[in] CallParameters

バッファーに格納されたCO_CALL_PARAMETERS構造体へのポインター。クライアントはこのバッファーを割り当て、このポインターを NdisClMakeCall に渡す前に、クライアントによって決定されたデータを使用してこの構造体を初期化しました。クライアントの要求の処理中に、呼び出しマネージャーは、ネットワークまたはシグナリングピアとのネゴシエーションの結果を反映するように、このデータを変更できます。

戻り値

なし

解説

ProtocolClMakeCallComplete の呼び出しは、呼び出しマネージャーが NdisClMakeCall との仮想接続を確立するためのクライアントの要求の処理を完了したことを示します。

クライアントによる発信呼び出しの確立が失敗した場合 (入力状態はNDIS_STATUS_SUCCESSを除く)、 ProtocolClMakeCallComplete は次の操作を行う必要があります。

ProtocolPartyContext 領域 (存在する場合) と、クライアントが割り当てた CallParameters のバッファーを解放または再利用する準備をします。
クライアントによって作成された VC を NdisCoDeleteVc の呼び出しで破棄し、クライアント割り当て ProtocolVcContext 領域を解放または再利用する準備をします。

それ以外の場合は、 ProtocolClMakeCallComplete で次の操作を行う必要があります。

CallParameters の構造体の Flags メンバーを調べて、CALL_PARAMETERS_CHANGEDが設定されているかどうかを確認します。これは、呼び出しマネージャーがクライアント指定の呼び出しパラメーターを変更したことを示します。
その場合は、 CallParameters のデータを調べて、この接続で許容されるかどうかを判断します。
たとえば、クライアントは、アクティブな VC のバッファーされた呼び出しパラメーターを保持し、これがマルチポイント VC の場合は NdisPartyHandle を保存し、通常は、指定された呼び出しパラメーターが満足できる場合は、後続の転送やその他の操作のためにクライアントをアクティブな VC に対して準備します。
そうでない場合、シグナリングプロトコルは、クライアントが呼び出しマネージャーと許容される呼び出しパラメーターの再ネゴシエーションを試みることができるかどうかを判断します。
たとえば、特定の呼び出しマネージャーは、このような状況でクライアントが NdisClModifyCallQoS を 1 回以上呼び出せるようにすることがあります。
CM で変更された呼び出しパラメーターが許容できず、それ以上の再ネゴシエーションが不可能な場合、 ProtocolClMakeCallComplete は NdisClCloseCall を使用して呼び出しを破棄する必要があります。
この場合、ProtocolClMakeCallComplete は NdisClCloseCall からのリターン時にクライアント割り当てリソースの解放を試みるのではなく、単に制御を返すことができます。代わりに、クライアントは ProtocolClCloseCallComplete 関数内で割り当てたリソースを解放する (または再利用できるように準備する) 必要があります。

例

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

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

PROTOCOL_CL_MAKE_CALL_COMPLETE MyClMakeCallComplete;

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

_Use_decl_annotations_
VOID
 MyClMakeCallComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolVcContext,
    NDIS_HANDLE  NdisPartyHandle,
    PCO_CALL_PARAMETERS  CallParameters
    )
  {...}

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

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

要件

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