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

[アーティクル]
02/07/2025

着信呼び出しを受け入れる接続指向 NDIS クライアントには、NdisClRegisterSapで開始する非同期操作を完了するために、ProtocolClRegisterSapComplete 関数が必要です。それ以外の場合、このようなプロトコルドライバーの登録 ProtocolClRegisterSapComplete 関数は、単に制御を返すことができます。

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

構文

PROTOCOL_CL_REGISTER_SAP_COMPLETE ProtocolClRegisterSapComplete;

void ProtocolClRegisterSapComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolSapContext,
  [in] PCO_SAP Sap,
  [in] NDIS_HANDLE NdisSapHandle
)
{...}

パラメーター

[in] Status

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

NDIS_STATUS_SUCCESS

SAP は NDIS と呼び出しマネージャーの両方に登録され、その後呼び出されます。 NdisCmDispatchIncomingCall 特定の SAP に向けられた着信呼び出しオファーを受信するたびに、NDIS がクライアントの呼び出しを引き起こします。ProtocolClIncomingCall 関数をします。

NDIS_STATUS_RESOURCES

NDIS または呼び出しマネージャーは、SAP を登録および維持するために必要なリソースを割り当てたり初期化したりできませんでした。

NDIS_STATUS_INVALID_DATA

クライアントは、Sap で無効な仕様を NDIS に提供しました。この仕様は、検証のために呼び出しマネージャーの ProtocolCmRegisterSap 関数に転送されました。

NDIS_STATUS_XXX

呼び出しマネージャーは、指定された SAP を登録しようとしたときにエラーが発生し、NDIS は、この CM によって決定されたエラー状態をクライアントに伝達しました。

[in] ProtocolSapContext

クライアントが NDISClRegisterSap を呼び出したときに最初に NDIS に提供されたクライアントの SAP ごとのコンテキスト領域ハンドルを指定します。登録が成功した場合、NDIS はこのコンテキストハンドルを保持し、その後、この SAP に関連するクライアントの ProtocolClIncomingCall 関数の呼び出しで使用します。

[in] Sap

開く SAP の仕様を含むクライアント割り当てバッファーへのポインター。クライアントは、最初にこのポインターを NdisClRegisterSap 渡しました。

[in] NdisSapHandle

状態がNDIS_STATUS_SUCCESSされている場合は、この登録済み SAP に対する NDIS 提供の有効なハンドルを指定します。実質的には、クライアントとクライアントが指定した SAP の特定の呼び出しマネージャーの間で NDIS と確立された関連付けを指定します。それ以外の場合、このパラメーターは NULL 。クライアントは、NdisClDeregisterSap への最終的な呼び出しのために、有効なハンドル (できれば ProtocolSapContext 領域)保存する必要があります。

戻り値

何一つ

備考

NDIS ProtocolClRegisterSapComplete を呼び出して、NdisClRegisterSap をするクライアントの以前の呼び出しが NDIS によって処理されたことを示します。NDIS が呼び出しに失敗しなかった場合は、クライアントが ndisClRegisterSap に渡した NdisAfHandle を共有する呼び出しマネージャーによって行われます。

接続指向 NIC を介して着信呼び出しを受信するには、クライアントの ProtocolCoAfRegisterNotify または ProtocolClOpenAfCompleteEx 関数は、通常、1 つ以上の SAP を呼び出しマネージャーに登録します。

各 SAP を登録するために、クライアントは NdisClRegisterSap 呼び出しを行い、クライアントが着信呼び出しの通知を受信する呼び出しマネージャーを識別する NdisAfHandle を渡します。NDIS は、クライアントが NdisClRegisterSap へのクライアントの呼び出 しに成功した場合、登録された SAP に NdisSapHandle を返します。 ProtocolClRegisterSapComplete は、クライアントの SAP ProtocolSapContext 領域で、通常は NdisSapHandle の有効な各を保存する必要があります。これは、後で ndisClDeregisterSap して SAP を解放できるようにします。

SAP の形式は、呼び出しマネージャーに固有です。クライアントが登録しようとしている SAP が呼び出しマネージャーで認識されない場合、または指定された SAP が既に使用されている場合、呼び出しマネージャーは SAP 登録を失敗させる可能性があります。 ProtocolClRegisterSapComplete 、さらに進む前に、NDIS_STATUS_SUCCESSの入力状態を確認する必要があります。 SAP の登録が失敗した場合は、次の手順を実行します。
ProtocolClRegisterSapComplete は、クライアントが割り当てた sap SAP コンテキスト領域とバッファーを解放するか、NdisClRegisterSap をする別の呼び出しで再利用できるように準備することができます。

クライアントは、SAP 登録が保留中の間、つまり、ProtocolClRegisterSapComplete 関数が呼び出される前に、SAP で着信呼び出しを受信できます。

の例

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

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

PROTOCOL_CL_REGISTER_SAP_COMPLETE MyClRegisterSapComplete;

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

_Use_decl_annotations_
VOID
 MyClRegisterSapComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolSapContext,
    PCO_SAP  Sap,
    NDIS_HANDLE  NdisSapHandle
    )
  {...}

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

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

必要条件

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

次の方法で共有