PROTOCOL_CM_OPEN_AF コールバック関数 (ndis.h)
ProtocolCmOpenAf 関数が必要です。 この関数は、アドレス ファミリを開いている接続指向 NDIS クライアントと対話するために、呼び出しマネージャーに対してオープンごとのリソースを割り当てます。
構文
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 は、その操作の状態を次のいずれかとして返します。
| リターン コード | 説明 |
|---|---|
|
呼び出しマネージャーが、クライアントからこのアドレス ファミリへの要求を受け入れるために必要なリソースを正常に割り当て、初期化したことを示します。 |
|
要求された操作が非同期的に処理されていることを示します。 呼び出しマネージャーは、 を呼び出す必要があります NdisCmOpenAddressFamilyComplete 操作が完了したことを NDIS (およびクライアント) に示すために、すべての open-AF 操作が完了したとき。 |
|
メモリなどの使用可能なシステム リソースがないため、呼び出しマネージャーが必要な操作を完了できなかったことを示します。 |
|
呼び出しマネージャーが、このアドレス ファミリを操作するためのクライアントからの要求を受け入れることができる状態に設定できなかったことを示します。 これは、別の 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)」を参照) でサポートされています。 |
| 対象プラットフォーム | Windows |
| ヘッダー | ndis.h (Ndis.h を含む) |
| IRQL | <= DISPATCH_LEVEL |