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

[アーティクル]
03/05/2024

NDIS は、フィルタードライバーの FilterCancelOidRequest 関数を呼び出して OID 要求を取り消します。

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

構文

FILTER_CANCEL_OID_REQUEST FilterCancelOidRequest;

void FilterCancelOidRequest(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PVOID RequestId
)
{...}

パラメーター

[in] FilterModuleContext

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

[in] RequestId

要求のキャンセル識別子。この識別子は、取り消される NDIS_OID_REQUEST 構造体を指定します。

戻り値

なし

解説

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

NDIS が FilterCancelOidRequest を呼び出すとき、フィルタードライバーはできるだけ早く NdisFOidRequestComplete 関数の呼び出しを試みる必要があります。

要求パラメーターは、OidRequest でNDIS_OID_REQUEST構造体で定義されます。

フィルタードライバーが OID 要求をキューに入れない場合、 ドライバーは FilterCancelOidRequest 関数を提供するために必要ありません。フィルタードライバーで FilterCancelOidRequest エントリポイントが指定されていない場合、NDIS は基になるドライバーの取り消し OID 要求関数を呼び出します。

NDIS は、要求の発信元が要求を取り消したとき、またはタイムアウト メンバーで指定されたタイムアウトが期限切れになったときに FilterCancelOidRequest 関数を呼び出します。

フィルタードライバーで要求処理がまだ完了していない場合、ドライバーは状態が NDIS_STATUS_REQUEST_ABORTED に設定された NdisFOidRequestComplete 関数を呼び出します。

フィルタードライバーが基になるドライバーに要求を転送しても処理がまだ完了していない場合、フィルタードライバーは、基になるドライバーに送信された値に OidRequest パラメーターを設定して NdisFCancelOidRequest 関数を呼び出します。

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

例

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

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

FILTER_CANCEL_OID_REQUEST MyCancelOidRequest;

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

_Use_decl_annotations_
VOID
 MyCancelOidRequest(
    NDIS_HANDLE  FilterModuleContext,
    PVOID  RequestId
    )
  {...}

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

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

要件

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