SetTimer

Crea un timer con el valor especificado de time-out.

Sintaxis

UINT SetTimer(
  HWND hWnd,              // menejador de ventana que recibirá los mensajes del timer
  UINT nIDEvent,          // identificador del timer
  UINT uElapse,           // valor de time-out
  TIMERPROC lpTimerFunc   // dirección del procedimiento de timer
);

Parámetros

hWnd: Manejador de la ventana que será asociada con el timer. Esta ventana debe ser "poseída" (owned) por el hilo que llama. Si este parámetro es NULL, ninguna ventana es asociada con el timer y el parámetro nIDEvent es ignorado.

nIDEvent: Especifica un identificador del timer, distinto de cero. Si el parámetro hWnd es NULL, este parámetro es ignorado.

uElapse: Especifica el valor de time-out, en milisegundos.

lpTimerFunc: Puntero a la función que será notificada cuando el valor de time-out transcurra. Para más información acerca de esta función, ver TimerProc.

Si lpTimerFunc es NULL, el sistema postea un mensaje WM_TIMER a la cola de la aplicación. El miembro hwnd de la estructura MSG del mensaje contiene el valor del parámetro hwnd.

Valor de retorno

Si la función tiene éxito, el valor de retorno es un entero identificando el nuevo timer. Una aplicación puede pasar este valor, o el identificador de cadena, si existe, a la función KillTimer para destruir el timer.

Si la función falla en crear un timer, el valor de retorno es cero. Para obtener información extendida del error, llamar a GetLastError.

Observaciones

Una aplicación puede procesar mensajes WM_TIMER al incluir una etiqueta case para WM_TIMER en el procedimiento de ventana, o especificando una función callback TimerProc al crear el timer. Cuando se especifica una función callback TimerProc, el procedimiento de ventana por defecto llama a esta función cuando procesa el mensaje WM_TIMER. Por consiguiente, no se necesita despachar mensajes en el hilo que llama, incluso cuando se usa TimerProc en vez de procesar WM_TIMER.

El parámetro wParam de el mensaje WM_TIMER contiene el valor del parámetro nIDEvent.