PROTOCOL_CO_OID_REQUESTコールバック関数 (ndis.h)
ProtocolCoOidRequest 関数は、CoNDIS クライアントまたはスタンドアロン呼び出しマネージャーが NdisCoOidRequest 関数の呼び出しによって開始する OID 要求、またはミニポート呼び出しマネージャー (MCM) ドライバーが NdisMCmOidRequest 関数の呼び出しによって開始する OID 要求を処理します。
構文
PROTOCOL_CO_OID_REQUEST ProtocolCoOidRequest;
NDIS_STATUS ProtocolCoOidRequest(
[in] NDIS_HANDLE ProtocolAfContext,
[in] NDIS_HANDLE ProtocolVcContext,
[in] NDIS_HANDLE ProtocolPartyContext,
[in, out] PNDIS_OID_REQUEST OidRequest
)
{...}
パラメーター
[in] ProtocolAfContext
アドレス ファミリ (AF) コンテキスト領域を識別するハンドル。 ドライバーがクライアントの場合は、 を呼び出したときにこのハンドルを指定しました。 NdisClOpenAddressFamilyEx 関数を使用して、それ自体を呼び出しマネージャーに接続します。 ドライバーが呼び出しマネージャーの場合は、 ProtocolCmOpenAf 関数からこのハンドルを指定しました。
[in] ProtocolVcContext
要求が VC 固有の場合に、クエリを実行または設定する仮想接続 (VC) を識別するハンドル。 それ以外の場合、このパラメーターは NULL です。
[in] ProtocolPartyContext
要求がパーティ固有の場合に、クエリを実行または設定するマルチポイント VC 上のパーティを識別するハンドル。 それ以外の場合、このパラメーターは NULL です。
[in, out] OidRequest
ターゲット ドライバーが処理するバッファーと要求パケットの両方を含む NDIS_OID_REQUEST 構造体へのポインター。 要求に応じて、 ドライバーは OidRequest が指す構造体で要求された情報を返します。
戻り値
ProtocolCoOidRequest は、次のいずれかを返すことができます。
| リターン コード | 説明 |
|---|---|
|
クライアントまたは呼び出しマネージャーが要求された操作を実行しました。 |
|
クライアントまたは呼び出しマネージャーは、この要求を非同期的に処理しており、 NdisCoOidRequestComplete 関数または要求された操作が完了した場合の NdisMCmOidRequestComplete 関数。 |
|
NdisCoOidRequest 関数または NdisMCmOidRequest 関数の呼び出し元が、指定された要求のNDIS_OID_REQUEST構造体の InformationBuffer メンバーに適切な値を指定しなかったため、ドライバーは要求を失敗しています。 ドライバーは、OidRequest パラメーターのバッファー内のNDIS_OID_REQUESTの BytesNeeded メンバーを、要求された操作を実行するために必要な InformationBufferLength メンバーの OID 固有の値に設定します。 |
|
クライアントまたは呼び出しマネージャーが、セットに対して指定された無効な入力データなど、ドライバーによって決定された理由で要求に失敗しました。 |
|
クライアントまたは呼び出しマネージャーは、NdisRequest のバッファー内の Oid メンバーのOID_GEN_CO_XXX コードを認識しなかったため、この要求に失敗しました。 |
注釈
ProtocolCoOidRequest 関数は、CoNDIS クライアント、呼び出しマネージャー、および MCM に必要です。 ProtocolCoOidRequest は、ミニポート ドライバーの MiniportCoOidRequest 関数に 似ています。
CoNDIS クライアントと呼び出しマネージャーは、NdisCoOidRequest 関数を呼び出すときに NdisAfHandle パラメーターに NULL 以外の値を指定することで、相互に情報を送信します。 同様に、MCM は NdisAfHandle の明示的な値を使用して NdisMCmOidRequest を呼び出して、クライアントに情報を通信します。 このような NdisCoOidRequest または NdisMCmOidRequest の呼び出しにより、NDIS は、指定された AF ハンドルに関連付けられている対象のクライアント、呼び出しマネージャー、または MCM の ProtocolCoOidRequest 関数を呼び出します。
ProtocolCoOidRequest をクライアントとして登録するには、 構造体NDIS_CO_CLIENT_OPTIONAL_HANDLERSし、NdisSetOptionalHandlers 関数の OptionalHandlers パラメーターで渡します。 ProtocolCoOidRequest を呼び出しマネージャーとして登録するには、 構造体NDIS_CO_CALL_MANAGER_OPTIONAL_HANDLERS し、 OptionalHandlers パラメーターで渡します。
NdisCoOidRequest または NdisMCmOidRequest の NdisVcHandle パラメーターと NdisPartyHandle パラメーターが NULL の場合、要求は本質的にグローバルです。 つまり、 NdisVcHandle または NdisPartyHandle の明示的な値は、 ProtocolCoOidRequest がそれぞれ VC ごとまたはパーティごとに指定された要求を満たす必要があることを示します。
OidRequest パラメーターのバッファーは非ページ プールから割り当てられたため、発生した IRQL でアクセスできます。 NdisCoOidRequest(または NdisMCmOidRequest) の呼び出し元は、OidRequest が指すNDIS_OID_REQUEST構造体の InformationBuffer メンバーで、このバッファーと内部バッファーを解放する必要があります。
ProtocolCoOidRequest がNDIS_STATUS_PENDINGを返す場合、ドライバーは後で を呼び出す必要があります。 NdisCoOidRequestComplete 関数、またはドライバーが要求を完了すると、MCM ドライバーの NdisMCmOidRequestComplete 関数。
例
ProtocolCoOidRequest 関数を定義するには、まず、定義する関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数型のセットが用意されています。 関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。たとえば、" MyCoOidRequest" という名前の ProtocolCoOidRequest 関数を定義するには、次のコード例に示すように 、PROTOCOL_CO_OID_REQUEST 型を使用します。
PROTOCOL_CO_OID_REQUEST MyCoOidRequest;
次に、次のように関数を実装します。
_Use_decl_annotations_
NDIS_STATUS
MyCoOidRequest(
NDIS_HANDLE ProtocolAfContext,
NDIS_HANDLE ProtocolVcContext,
NDIS_HANDLE ProtocolPartyContext,
PNDIS_OID_REQUEST OidRequest
)
{...}
PROTOCOL_CO_OID_REQUEST関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のPROTOCOL_CO_OID_REQUEST関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。
Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | NDIS 6.0 以降でサポートされています。 |
| 対象プラットフォーム | Windows |
| ヘッダー | ndis.h (Ndis.h を含む) |
| IRQL | <= DISPATCH_LEVEL |