PROTOCOL_CO_OID_REQUEST_COMPLETE コールバック関数 (ndis.h)
ProtocolCoOidRequestComplete 関数は、非同期 CoNDIS OID 要求の処理を完了します。
構文
PROTOCOL_CO_OID_REQUEST_COMPLETE ProtocolCoOidRequestComplete;
void ProtocolCoOidRequestComplete(
[in] NDIS_HANDLE ProtocolAfContext,
[in] NDIS_HANDLE ProtocolVcContext,
[in] NDIS_HANDLE ProtocolPartyContext,
[in, out] PNDIS_OID_REQUEST OidRequest,
[in] NDIS_STATUS Status
)
{...}
パラメーター
[in] ProtocolAfContext
アドレス ファミリ (AF) コンテキスト領域を識別するハンドル。 ドライバーがクライアントの場合は、ドライバーがクライアントを呼び出したときにこのハンドルを指定しました。NdisClOpenAddressFamilyEx 関数を して、それ自体を呼び出しマネージャーに接続します。 ドライバーが呼び出しマネージャーまたはミニポート呼び出しマネージャー (MCM) の場合は、ProtocolCmOpenAf 関数からこのハンドルを指定します。
[in] ProtocolVcContext
要求が VC 固有の場合、ドライバーが要求または情報を設定したアクティブな仮想接続 (VC) を識別するハンドル。 それ以外の場合、このパラメーターは NULL 。
[in] ProtocolPartyContext
要求がパーティ固有の場合、ドライバーが情報を要求または設定したマルチポイント VC 上のパーティーを識別するハンドル。 それ以外の場合、このパラメーターは NULL 。
[in, out] OidRequest
以前に NdisCoOidRequest または NdisMCmOidRequest 関数に渡されたドライバー提供 の NDIS_OID_REQUEST 構造体へのポインター。
[in] Status
要求の最終的な状態。 ターゲット ドライバーまたは NDIS は、この最終的な状態を決定します。 このパラメーターは、OidRequestの情報で ProtocolCoOidRequestComplete が行う を決定します。
戻り値
何一つ
備考
NDIS は、ProtocolCoOidRequestComplete 関数を呼び出して、NdisCoOidRequest 関数または NdisMCmOidRequest 関数がNDIS_STATUS_PENDING返された CoNDIS クライアント、呼び出しマネージャー、または MCM OID 要求の処理を完了します。
ProtocolCoOidRequestComplete クライアントとして登録するには、ドライバーが構造体を NDIS_CO_CLIENT_OPTIONAL_HANDLERS し、NdisSetOptionalHandlers 関数の OptionalHandlers パラメーターで渡します。 ProtocolCoOidRequestComplete 呼び出しマネージャーとして登録するには、ドライバーが構造体を NDIS_CO_CALL_MANAGER_OPTIONAL_HANDLERS し、OptionalHandlersNdisSetOptionalHandlersのパラメーターで渡します。
ターゲット ドライバーは、OID 情報要求を処理するドライバーです。 ターゲット ドライバーの NdisMCoOidRequestComplete、NdisCoOidRequestComplete、またはNdisMCmOidRequestComplete 関数、NDIS が ProtocolCoOidRequestComplete 関数を呼び出しました。 NDIS は、ProtocolCoOidRequestCompleteに入力 状態 パラメーターとしてこれらの関数に渡された 状態 パラメーターの値を転送します。
ProtocolCoOidRequestComplete では、次のように Status の入力値が使用されます。
-
状態 がNDIS_STATUS_SUCCESSされている場合は、次の操作を行います。 OidRequest パラメーターが指す NDIS_OID_REQUEST 構造体の BytesRead または BytesWritten メンバーは、NDIS_OID_REQUESTの InformationBuffer メンバーから転送された情報の量、または InformationBuffer で返された情報の量を指定します。 それぞれ。
ドライバーがクエリ要求を行った場合、ProtocolCoOidRequestComplete は、NDIS_OID_REQUESTの Oid メンバーで指定された値に応じて、InformationBuffer で返されるデータを使用できます。
-
Status がNDIS_STATUS_INVALID_LENGTHまたはNDIS_STATUS_BUFFER_TOO_SHORTの場合、OidRequest NDIS_OID_REQUEST構造体の BytesNeeded メンバーは、要求された操作を実行するために必要なNDIS_OID_REQUESTの InformationBufferLength メンバーの OID 固有の値を指定することを指します。
このような状況では、ProtocolCoOidRequestComplete は、要求に十分なバッファー領域を割り当て、InformationBufferLength に必要な値を持つ別の NDIS_OID_REQUEST 構造体設定し、OID 要求を再試行できます。
- 状態 が回復不可能なエラーであるNDIS_STATUS_ XXX 値である場合は、ProtocolCoOidRequestComplete NDIS_OID_REQUEST構造体のメモリを解放する必要があります。 ProtocolCoOidRequestComplete では、ドライバーがバインドを閉じるか、バインド固有の状態情報を調整して、バインドに対する継続的なネットワーク I/O 操作を処理する必要があるかも判断する必要があります。
ProtocolCoOidRequestComplete は、NdisCoOidRequest または NdisMCmOidRequest が返 状態コードを調べる時間がドライバーに発生する前に呼び出すことができます。
NDIS は、IRQL <= DISPATCH_LEVEL で ProtocolCoOidRequestComplete 呼び出します。
の例
ProtocolCoOidRequestComplete 関数を定義するには、まず、定義する関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数の種類のセットが用意されています。 関数の種類を使用して関数を宣言すると、ドライバー のコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールをすると、エラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。たとえば、"MyCoOidRequestComplete" という名前の ProtocolCoOidRequestComplete 関数を定義するには、次のコード例に示すように PROTOCOL_CO_OID_REQUEST_COMPLETE 型を使用します。
PROTOCOL_CO_OID_REQUEST_COMPLETE MyCoOidRequestComplete;
次に、次のように関数を実装します。
_Use_decl_annotations_
VOID
MyCoOidRequestComplete(
NDIS_HANDLE ProtocolAfContext,
NDIS_HANDLE ProtocolVcContext,
NDIS_HANDLE ProtocolPartyContext,
PNDIS_OID_REQUEST OidRequest,
NDIS_STATUS Status
)
{...}
PROTOCOL_CO_OID_REQUEST_COMPLETE 関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内の PROTOCOL_CO_OID_REQUEST_COMPLETE 関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「ndis ドライバーの の関数の役割の種類を使用して関数を宣言するを参照してください。
Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | NDIS 6.0 以降でサポートされています。 |
ターゲット プラットフォーム の | ウィンドウズ |
ヘッダー | ndis.h (Ndis.h を含む) |
IRQL | <= DISPATCH_LEVEL (「解説」セクションを参照) |
関連項目
NDIS_CO_CALL_MANAGER_OPTIONAL_HANDLERS NDIS_CO_CLIENT_OPTIONAL_HANDLERSNdisClOpenAddressFamilyEx の
NdisCoOidRequest の
NdisCoOidRequestComplete の
NdisMCmOidRequest の
NdisMCmOidRequestComplete の
NdisMCoOidRequestComplete の