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

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

NDIS は、フィルタードライバーの FilterOidRequest 関数を呼び出して、指定したフィルターモジュールに関連付けられている OID 要求を処理します。

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

構文

FILTER_OID_REQUEST FilterOidRequest;

NDIS_STATUS FilterOidRequest(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PNDIS_OID_REQUEST OidRequest
)
{...}

パラメーター

[in] FilterModuleContext

この要求のターゲットであるフィルターモジュールのコンテキスト領域へのハンドル。フィルタードライバーは、FilterAttach 関数でこのコンテキスト領域を作成して初期化しました。

[in] OidRequest

OID_XXX コードを含む、要求された操作を指定する NDIS_OID_REQUEST 構造体へのポインター。構造体では、OID クエリ要求または OID セット要求のいずれかを指定できます。 OID の詳細については、「NDIS OID を参照してください。

戻り値

FilterOidRequest は、次のいずれかの状態値を返します。

リターンコード	形容
NDIS_STATUS_SUCCESS	FilterOidRequest、このフィルターモジュールのフィルタードライバーのクエリまたは設定操作が正常に完了しました。
NDIS_STATUS_PENDING	フィルタードライバーが要求を非同期的に完了することを示します。ドライバーは、要求を完了した後、次を呼び出す必要があります。NdisFOidRequestComplete 関数をして、要求が完了したことを NDIS に通知します。
NDIS_STATUS_INVALID_OID	OidRequest で指定要求が無効であるか、認識されていないことを示します。
NDIS_STATUS_NOT_SUPPORTED	FilterOidRequest が OID をサポートしていない、OID は省略可能です。
NDIS_STATUS_BUFFER_TOO_SHORT	OidRequest で指定バッファーが小さすぎて、要求されたデータを保持できません。
NDIS_STATUS_INVALID_LENGTH	クエリ操作の場合、NDIS_OID_REQUEST 構造体の InformationBufferLength メンバーが、指定された OID に必要な長さと一致しません。 FilterOidRequest は、NDIS_OID_REQUEST構造体の BytesNeeded メンバーに必要なバッファーサイズ (バイト単位) を返します。
NDIS_STATUS_INVALID_DATA	設定操作の場合、NDIS_OID_REQUEST構造体の InformationBuffer メンバーに指定されたデータが、指定された OID に対して無効でした。
NDIS_STATUS_NOT_ACCEPTED	FilterOidRequest 要求された情報を収集しようとしましたが、失敗しました。
NDIS_STATUS_RESOURCES	リソースが不足しているため、FilterOidRequest 失敗しました。
NDIS_STATUS_FAILURE	FilterOidRequest は、上記の値が適用されない場合にNDIS_STATUS_FAILUREを返します。フィルタードライバーは、エラーの理由を指定するパラメーターを使用して、NdisWriteErrorLogEntry 関数を呼び出す必要があります。

備考

FilterOidRequest は省略可能な関数です。フィルタードライバーは、OID 要求を使用しない場合は、NdisFRegisterFilterDriver 関数を呼び出すときに NULL をするには、この関数のエントリポイントを設定できます。フィルタードライバーは、FilterOidRequestComplete 関数を定義する場合は、FilterOidRequest 関数を提供する必要があります。

NDIS は、フィルタードライバーの FilterOidRequest 関数を呼び出して、基になるドライバーによって発生した OID 要求を処理します。フィルタードライバーは、NdisFOidRequest 関数を呼び出すことによって、このような要求を基になるドライバーに転送できます。

ドライバーが NdisFOidRequest 呼び出す前に、ドライバーは NDIS_OID_REQUEST 構造体を割り当て、NdisAllocateCloneOidRequest 呼び出すことによって新しい構造体に要求情報を転送する必要があります。オプションとして、フィルタードライバーは要求を転送せずにすぐに要求を完了できます。

要求を同期的に完了するために、フィルタードライバーはNDIS_STATUS_SUCCESSまたはエラー状態を返します。ドライバーは、NDIS_STATUS_PENDINGを返す場合は、要求が完了したことを NDIS に通知する NdisFOidRequestComplete 関数を呼び出す必要があります。

クエリ操作の場合、FilterOidRequest は、InformationBuffer メンバーで要求された情報を返し、BytesWritten メンバーのNDIS_OID_REQUEST構造体の変数を返された情報の量に設定します。基になるドライバーは、フィルタードライバーが NdisFOidRequest で要求渡した場合にこれを行います。

設定操作の場合、FilterOidRequest は、NDIS_OID_REQUEST構造体の InformationBuffer メンバー内のデータを使用して、指定された OID で必要な情報を設定できます。この場合、FilterOidRequest 、BytesRead の変数を、使用した指定されたデータの量に設定します。基になるドライバーは、フィルタードライバーが NdisFOidRequest で要求渡した場合にこれを行います。

ミニポートドライバーと同様に、フィルタードライバーは一度に 1 つの要求のみを受信できます。 NDIS は、フィルタードライバーに送信する要求をシリアル化します。 NDIS は、フィルタードライバーが現在の要求を完了する前に、FilterOidRequest を呼び出すことができません。

NDIS は、IRQL <= DISPATCH_LEVEL で FilterOidRequest 呼び出します。

の例

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

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

FILTER_OID_REQUEST MyOidRequest;

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

_Use_decl_annotations_
NDIS_STATUS
 MyOidRequest(
    NDIS_HANDLE  FilterModuleContext,
    PNDIS_OID_REQUEST  OidRequest
    )
  {...}

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

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

必要条件

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

次の方法で共有

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

構文

パラメーター

戻り値

備考

の例

必要条件

関連項目

フィードバック

その他のリソース