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

  • [アーティクル]

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

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

構文

PROTOCOL_CL_DEREGISTER_SAP_COMPLETE ProtocolClDeregisterSapComplete;

void ProtocolClDeregisterSapComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolSapContext
)
{...}

パラメーター

[in] Status

SAP の登録を解除するクライアントの要求の最終的な状態を指定します。これは、次のいずれかになります。

NDIS_STATUS_SUCCESS

SAP が閉じられました。 クライアントが以前に登録した SAP を表す NdisSapHandle (クライアントが ProtocolSapContext 領域に格納されている) が無効になりました。

NDIS_STATUS_FAILURE

NDIS は AF の状態を "終了" としてマークしていたため、 NdisSapHandle によって表される関連付けられた SAP は、クライアントの の呼び出し時に既にリリースされました NdisClDeregisterSap が発生しました。

NDIS_STATUS_XXX

呼び出しマネージャーは、何らかの CM によって決定された理由で SAP を閉じる要求を失敗させ、NDIS によって返された状態を伝達しました。 クライアントへの ProtocolCmDeregisterSap 関数。

[in] ProtocolSapContext

最初に NdisClRegisterSap を使用して NDIS に渡された、SAP ごとのコンテキスト領域に対するクライアント提供のハンドルを指定します。 呼び出しマネージャーがこの SAP の登録を正常に解除した後、クライアントはコンテキスト領域を解放するか、このコンテキスト領域を再利用できるように準備できます。

戻り値

なし

解説

ProtocolClDeregisterSapComplete の呼び出しは、NdisClDeregisterSap に対するクライアントの前の呼び出しが呼び出しマネージャーによって処理されたことを示します。

呼び出しマネージャーが CM によって決定された理由で登録解除に失敗しない限り、ProtocolClDeregisterSapComplete が呼び出されたときに、クライアントは NdisSapHandle が無効であると見なす必要があります。 その結果、 ProtocolClDeregisterSapComplete は、クライアントが割り当てた SAP ごとのコンテキスト領域を解放するか、 NdisClRegisterSap への後続の呼び出しで再利用できるように準備することができます。

例

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

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

PROTOCOL_CL_DEREGISTER_SAP_COMPLETE MyClDeregisterSapComplete;

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

_Use_decl_annotations_
VOID
 MyClDeregisterSapComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolSapContext
    )
  {...}

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

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

要件

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

こちらもご覧ください

NdisClDeregisterSap

NdisClRegisterSap

NdisCmDeregisterSapComplete

NdisFreeMemory

NdisFreeToNPagedLookasideList

NdisMCmDeregisterSapComplete

ProtocolCmDeregisterSap