Fungsi CancelWaitableTimer (synchapi.h)

Artikel
03/02/2024

Mengatur timer yang dapat ditunggu yang ditentukan ke status tidak aktif.

Sintaks

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Parameter

[in] hTimer

Handel ke objek timer. Fungsi CreateWaitableTimer atau OpenWaitableTimer mengembalikan handel ini. Handel harus memiliki hak akses TIMER_MODIFY_STATE . Untuk informasi selengkapnya, lihat Keamanan Objek Sinkronisasi dan Hak Akses.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Fungsi CancelWaitableTimer tidak mengubah status timer yang disinyalkan. Ini menghentikan timer sebelum dapat diatur ke status yang disinyalkan dan membatalkan APC yang beredar. Oleh karena itu, utas yang melakukan operasi tunggu pada timer tetap menunggu sampai waktu habis atau timer diaktifkan kembali dan statusnya diatur ke sinyal. Jika timer sudah dalam status disinyalkan, timer tetap dalam keadaan tersebut.

Untuk mengaktifkan kembali timer, panggil fungsi SetWaitableTimer .

Untuk mengkompilasi aplikasi yang menggunakan fungsi ini, tentukan _WIN32_WINNT sebagai 0x0400 atau yang lebih baru. Untuk informasi selengkapnya, lihat Menggunakan Header Windows.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	synchapi.h (termasuk Windows.h pada Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Objek Timer yang Dapat Ditunda