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

[アーティクル]
08/07/2023

ProtocolCoOidRequestComplete 関数は、非同期 CoNDIS OID 要求の処理を完了します。

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

構文

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し、NdisSetOptionalHandlers の OptionalHandlers パラメーターで渡します。

ターゲットドライバーは、OID 情報要求を処理したドライバーです。 NdisMCoOidRequestComplete、NdisCoOidRequestComplete、またはへのターゲットドライバーの呼び出し NdisMCmOidRequestComplete 関数により、NDIS は ProtocolCoOidRequestComplete 関数を呼び出しました。 NDIS は、入力 Status パラメーターとしてこれらの関数に渡された Status パラメーターの値を ProtocolCoOidRequestComplete に転送します。

ProtocolCoOidRequestComplete では、 Status の入力値を次のように使用します。

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 要求を再試行できます。
Status が回復不能なエラーであるNDIS_STATUS_ XXX 値の場合、ProtocolCoOidRequestComplete はNDIS_OID_REQUEST構造体のメモリを解放する必要があります。 ProtocolCoOidRequestComplete では、ドライバーがバインドを閉じるか、バインド固有の状態情報を調整して、バインドに対する継続的なネットワーク I/O 操作を処理する必要があるかも判断する必要があります。

システム定義 OID の詳細については、「 NDIS OID」を参照してください。

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 以降でサポートされています。
対象プラットフォーム	Windows
ヘッダー	ndis.h (Ndis.h を含む)
IRQL	<= DISPATCH_LEVEL (「解説」セクションを参照)