Função CancelWaitableTimer (synchapi.h)

  • Artigo

Define o temporizador de espera especificado como o estado inativo.

Sintaxe

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Parâmetros

[in] hTimer

Um identificador para o objeto de temporizador. A função CreateWaitableTimer ou OpenWaitableTimer retorna esse identificador . O identificador deve ter o acesso de TIMER_MODIFY_STATE correto. Para obter mais informações, consulte Segurança do objeto de sincronização e direitos de acesso.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função CancelWaitableTimer não altera o estado sinalizado do temporizador. Ele interrompe o temporizador antes que ele possa ser definido como o estado sinalizado e cancela APCs pendentes. Portanto, os threads que executam uma operação de espera no temporizador permanecem aguardando até atingirem o tempo limite ou que o temporizador seja reativado e seu estado esteja definido como sinalizado. Se o temporizador já estiver no estado sinalizado, ele permanecerá nesse estado.

Para reativar o temporizador, chame a função SetWaitableTimer .

Para compilar um aplicativo que usa essa função, defina _WIN32_WINNT como 0x0400 ou posterior. Para obter mais informações, consulte Usando os cabeçalhos do Windows.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [aplicativos da área de trabalho | aplicativos UWP]
Servidor mínimo com suporte Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho synchapi.h (inclua Windows.h no Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

CreateWaitableTimer

OpenWaitableTimer

SetWaitableTimer

Funções de sincronização

Objetos de temporizador de espera