ExCancelTimer 関数 (wdm.h)
ExCancelTimer ルーチンは、ExSetTimer ルーチンの以前の呼び出しによって設定されたタイマーを取り消します。
構文
BOOLEAN ExCancelTimer(
[in, out] PEX_TIMER Timer,
[in, optional] PEXT_CANCEL_PARAMETERS Parameters
);
パラメーター
[in, out] Timer
EX_TIMER構造体へのポインター。 この構造体は、 ExAllocateTimer ルーチンによって以前に割り当てられたタイマー オブジェクトです。
[in, optional] Parameters
ドライバーは、このパラメーターを NULL に設定する必要があります。
戻り値
タイマーが取り消された場合、このルーチンは TRUE を 返します。 それ以外の場合、ルーチンは FALSE を返します。
注釈
ドライバーが ExSetTimer ルーチンを呼び出してタイマーを設定した後、タイマーが期限切れになる前にキャンセルされる可能性があります。 ドライバーは、 ExCancelTimer ルーチンを呼び出して、保留中のタイマーを明示的に取り消すことができます。 また、ドライバーが ExSetTimer ルーチンを呼び出して、このオブジェクトに対して以前に設定したタイマーの有効期限が切れる前にタイマー オブジェクトに新しいタイマーを設定した場合、この ExSetTimer 呼び出しでは、前のタイマーが暗黙的に取り消され、新しいタイマーが開始されます。
TRUE の戻り値は、ExCancelTimer が呼び出されたときにタイマーが設定されたことを示します。 この場合、ルーチンはタイマーを取り消します。 FALSE の戻り値は、タイマーが設定されていないことを示します。これは、タイマーが設定されていないこと、タイマーが既に取り消されていること、またはタイマーが既に期限切れになっていることを意味する可能性があります。
タイマーが期限切れになると、オペレーティング システムはタイマー オブジェクトに通知します。 オプションとして、ドライバーは、タイマーの有効期限が切れたときに呼び出される ExTimerCallback コールバック ルーチンを指定できます。 ドライバーがこのコールバック ルーチンを提供する場合、タイマー オブジェクトが通知された場合、このルーチンが呼び出されることが保証されます。 有効期限が切れる前にタイマーが取り消された場合、タイマー オブジェクトは通知されず、コールバック ルーチンは呼び出されません。
詳細については、「 ExXxxTimer ルーチン」および「EX_TIMER オブジェクト」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 8.1以降で使用できます。 |
| 対象プラットフォーム | ユニバーサル |
| Header | wdm.h (Wdm.h、Ntddk.h、Ntifs.h を含む) |
| Library | Ntoskrnl.lib |
| IRQL | <= DISPATCH_LEVEL |