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

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

ProtocolCmOpenAf 関数が必要です。この関数は、アドレスファミリを開いている接続指向 NDIS クライアントと対話する呼び出しマネージャーの開いているリソースごとに割り当てます。

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

構文

PROTOCOL_CM_OPEN_AF ProtocolCmOpenAf;

NDIS_STATUS ProtocolCmOpenAf(
  [in]  NDIS_HANDLE CallMgrBindingContext,
  [in]  PCO_ADDRESS_FAMILY AddressFamily,
  [in]  NDIS_HANDLE NdisAfHandle,
  [out] PNDIS_HANDLE CallMgrAfContext
)
{...}

パラメーター

[in] CallMgrBindingContext

非統合呼び出しマネージャーの場合、CallMgrBindingContext は、呼び出しマネージャーがバインドごとの状態情報を保持する、呼び出しマネージャーによって割り当てられたコンテキスト領域へのハンドルを指定します。呼び出しマネージャーは、NdisOpenAdapterEx 呼び出されたときに、このハンドルを指定しました。

統合呼び出しマネージャー (MCM) の場合、CallMgrBindingContext は、ミニポートがアダプターごとの状態情報を保持するミニポート割り当てコンテキスト領域へのハンドルを指定します。ミニポートは、NdisMSetAttributesEx 呼び出し (5.x ドライバーの場合) またはその NdisMSetMiniportAttributes 呼び出し (6.x ドライバーの場合) でこのハンドルを提供しました。

[in] AddressFamily

クライアントが開くアドレスファミリを指定します。このアドレスファミリは、呼び出し時にコールマネージャによって登録されましたNdisCmRegisterAddressFamilyEx をします。

[in] NdisAfHandle

NDIS によって提供される、このアドレスファミリインスタンスを一意に識別するハンドルを指定します。このハンドルは呼び出しマネージャーに対して不透明であり、システム用に予約されています。

[out] CallMgrAfContext

呼び出しマネージャーが提供するアドレスファミリのこのオープンに関する状態を維持する、呼び出しマネージャーが指定したコンテキスト領域へのハンドルを指定します。

戻り値

ProtocolCmOpenAf は、次のいずれかの操作の状態を返します。

リターンコード	形容
NDIS_STATUS_SUCCESS	呼び出しマネージャーが、クライアントからこのアドレスファミリへの要求を受け入れるために必要なリソースを正常に割り当てて初期化したことを示します。
NDIS_STATUS_PENDING	要求された操作が非同期的に処理されていることを示します。呼び出しマネージャーが呼び出す必要がある NdisCmOpenAddressFamilyComplete 操作が完了したことを NDIS (およびクライアント) に示すためにすべての open-AF 操作が完了したときです。
NDIS_STATUS_RESOURCES	メモリなどの使用可能なシステムリソースがないため、呼び出しマネージャーが必要な操作を完了できなかったことを示します。
NDIS_STATUS_XXX	呼び出しマネージャーが、このアドレスファミリを操作するクライアントからの要求を受け入れることができる状態に設定できなかったことを示します。これは、別の NDIS ライブラリ関数から伝達されたエラー状態、またはドライバーライターによって適切に判断されたエラー状態である可能性があります。

備考

ProtocolCmOpenAf は、このアドレスファミリのインスタンスを開いているクライアントに代わって、呼び出しマネージャーライターが操作を実行するために必要と判断した動的リソースと構造体の必要な割り当てを実行します。このようなリソースには、メモリバッファー、データ構造、イベント、およびその他の同様のリソースが含まれますが、これらに限定されません。また、呼び出しマネージャーは、NDIS に制御を返す前に、開いているデータごとに関連するデータを初期化する必要があります。

呼び出しマネージャーが開いている状態領域ごとに割り当てられている場合は、NDIS に制御を返す前に、CallMgrAfContext ハンドルで状態領域のアドレスを設定する必要があります。これを行うには、CallMgrAfContext 逆参照 し、データ領域へのポインターをハンドルの値として格納します。例えば：

*CallMgrAfContext = SomeBuffer;

ProtocolCmOpenAf 、このアドレスファミリを開くクライアントの代わりに後続の要求を実行するために必要なオープンごとのリソースを割り当てることができない場合は、開いているコントロールに割り当てたすべてのリソースを解放し、NDIS_STATUS_RESOURCESを使用して NDIS に制御を返す必要があります。

ProtocolCmOpenAf が必要な操作を完了し、CM がクライアントからの要求を受け入れる準備ができている場合、protocolCmOpenAf は、NDIS_STATUS_SUCCESSの状態で可能な限り迅速に制御を返す必要があります。

の例

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

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

PROTOCOL_CM_OPEN_AF MyCmOpenAf;

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

_Use_decl_annotations_
NDIS_STATUS
 MyCmOpenAf(
    NDIS_HANDLE  CallMgrBindingContext,
    PCO_ADDRESS_FAMILY  AddressFamily,
    NDIS_HANDLE  NdisAfHandle,
    PNDIS_HANDLE  CallMgrAfContext
    )
  {...}

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

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

必要条件

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

次の方法で共有

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

構文

パラメーター

戻り値

備考

の例

必要条件

関連項目

フィードバック

その他のリソース