KillTimer

指定されたタイマーを破棄します。

BOOL KillTimer(
    HWND     hWnd,     // window handle
    UINT_PTR nIDEvent  // timer ID
);

USER32.DLL

引数

hWnd

タイマーが関連付けられているウィンドウのハンドルを指定します。この値は、タイマーを作成する際にSetTimer関数のhWndパラメータに渡された値と同じでなければいけません。

nIDEvent

破棄するタイマーのタイマーIDを指定します。

SetTimer関数に有効なウィンドウハンドルを渡した場合には、このパラメータにはSetTimer関数のnIDEventパラメータの値と同じ値を指定しなければいけません。SetTimer関数のhWndパラメータに0 (NULL) を指定した場合には、このパラメータにはSetTimer関数によって返されたタイマーIDを指定しなければいけません。

戻り値

関数が成功すると、戻り値として0以外の値が返ります。

関数が失敗すると、戻り値として0が返ります。拡張エラー情報を取得するには、GetLastError関数を使います。

解説

KillTimer関数は、既にメッセージキューにポストされているWM_TIMERメッセージを削除しません。

対応情報

Windows 95 以降 / Windows NT 3.1 以降