Función CancelWaitableTimer (synchapi.h)

Artículo
03/02/2024

Establece el temporizador de espera especificado en el estado inactivo.

Sintaxis

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Parámetros

[in] hTimer

Identificador del objeto de temporizador. La función CreateWaitableTimer o OpenWaitableTimer devuelve este identificador. El identificador debe tener el derecho de acceso TIMER_MODIFY_STATE . Para obtener más información, vea Synchronization Object Security and Access Rights.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función CancelWaitableTimer no cambia el estado señalado del temporizador. Detiene el temporizador antes de que se pueda establecer en el estado señalado y cancela las API pendientes. Por lo tanto, los subprocesos que realizan una operación de espera en el temporizador permanecen esperando hasta que agota el tiempo de espera o se reactiva el temporizador y su estado se establece en señalado. Si el temporizador ya está en estado señalado, permanece en ese estado.

Para reactivar el temporizador, llame a la función SetWaitableTimer .

Para compilar una aplicación que usa esta función, defina _WIN32_WINNT como 0x0400 o posterior. Para obtener más información, vea Usar los encabezados de Windows.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	synchapi.h (incluye Windows.h en Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll