NDIS_TIMER_FUNCTION コールバック関数 (ndis.h)
NdisTimerFunction コールバック関数は、ドライバーがタイマーの起動時にワンショットまたは定期的なタイマーを設定した後、NDIS によって呼び出されます。
構文
NDIS_TIMER_FUNCTION NdisTimerFunction;
void NdisTimerFunction(
[in] PVOID SystemSpecific1,
[in] PVOID FunctionContext,
[in] PVOID SystemSpecific2,
[in] PVOID SystemSpecific3
)
{...}
パラメーター
[in] SystemSpecific1
システムで使用するために予約されているシステム固有の値へのポインター。
[in] FunctionContext
ドライバーが NdisSetTimerObject 関数に渡したドライバー指定のコンテキスト領域へのポインター。 NdisSetTimerObject の FunctionContext パラメーターが NULL の場合、NDIS はドライバーがで指定した既定値を使用します。 NDIS_TIMER_CHARACTERISTICS 構造体。 ドライバーは、関連付けられているタイマー オブジェクトを初期化する NdisAllocateTimerObject 関数に構造体を渡しました。
[in] SystemSpecific2
システムで使用するために予約されているシステム固有の値へのポインター。
[in] SystemSpecific3
システムで使用するために予約されているシステム固有の値へのポインター。
戻り値
なし
解説
すべての NDIS ドライバーには、1 つ以上 の NdisTimerFunction コールバック関数を含めることができます。 このような 各 NdisTimerFunction コールバックは、ドライバーによって割り当てられ、初期化された別のタイマー オブジェクトに関連付けられている必要があります。
ドライバーは、 を呼び出すことによって、ドライバーによって割り当てられたタイマー オブジェクトを初期化します。 NdisAllocateTimerObject 関数。
NdisSetTimerObject 関数の後続の呼び出しにより、タイマー オブジェクトに関連付けられている NdisTimerFunction コールバックは、指定した間隔または定期的に実行されます。
NdisTimerFunction の呼び出しを取り消すには、NdisCancelTimerObject 関数を呼び出します。 NdisCancelTimerObject の呼び出しの前にタイムアウトが既に期限切れになっている場合でも、NDIS は NdisTimerFunction を呼び出す可能性があります。
NdisTimerFunction コールバックが他のドライバー関数とリソースを共有する場合、ドライバーはスピン ロックを使用してそれらのリソースへのアクセスを同期する必要があります。
例
NdisTimerFunction 関数を定義するには、まず、定義する関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバー用の一連の関数型が用意されています。 関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。たとえば、"MyTimerCallback" という名前の NdisTimerFunction 関数を定義するには、次のコード例に示すように 、NDIS_TIMER_FUNCTION 型を使用します。
NDIS_TIMER_FUNCTION MyTimerCallback;
次に、次のように関数を実装します。
_Use_decl_annotations_
VOID
MyTimerCallback(
PVOID SystemSpecific1,
PVOID FunctionContext,
PVOID SystemSpecific2,
PVOID SystemSpecific3
)
{...}
NDIS_TIMER_FUNCTION関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のNDIS_TIMER_FUNCTION関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。
Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | NDIS 6.0 以降でサポートされています。 |
| 対象プラットフォーム | Windows |
| ヘッダー | ndis.h (Ndis.h を含む) |
| IRQL | DISPATCH_LEVEL |