|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| No
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| No
| Platform Notes
| None
|
|
|
SetWaitableTimer
[New - Windows NT]
The SetWaitableTimer function activates the specified "waitable" timer. When the due time arrives,
the timer is signaled and the thread that set the timer calls the optional
completion routine.
BOOL SetWaitableTimer(
HANDLE hTimer,
| // handle to a timer object
| const LARGE_INTEGER *pDueTime,
| // when timer will become signaled
| LONG lPeriod,
| // periodic timer interval
| PTIMERAPCROUTINE pfnCompletionRoutine,
| // pointer to the completion routine
| LPVOID lpArgToCompletionRoutine,
| // data passed to the completion routine
| BOOL fResume
| // flag for resume state
| );
|
|
Parameters
hTimer
Identifies the timer object. The CreateWaitableTimer or OpenWaitableTimer function returns this handle.
pDueTime
Specifies when the state of the timer is to be set to signaled, in 100
nanosecond intervals. Use the format described by the FILETIME structure. Positive values indicate absolute time. Negative values indicate
relative time. The actual timer accuracy depends on the capability of your
hardware.
lPeriod
Specifies the period of the timer, in milliseconds. If lPeriod is zero, the timer is signaled once. If lPeriod is greater than zero, the timer is periodic. A periodic timer automatically
reactivates each time the period elapses, until the timer is canceled using the CancelWaitableTimer function or reset using SetWaitableTimer. If lPeriod is less than zero, the function fails.
pfnCompletionRoutine
Specifies an optional completion routine. The completion routine has the
following prototype:
VOID
(APIENTRY *PTIMERAPCROUTINE)(
LPVOID lpArgToCompletionRoutine,
DWORD dwTimerLowValue,
DWORD dwTimerHighValue
);
The argument for the completion routine is specified when the timer is made
active, in the lpArgToCompletionRoutine parameter. The completion routine also takes two DWORD values that specify the
high and low time values of the time at which the timer was signaled. These
values are passed to the routine by the system using the FILETIME format..
lpArgToCompletionRoutine
Pointer to the structure that is passed to the function specified by the
pointer pfnCompletionRoutine.
fResume
Specifies whether to restore a system in suspended power conservation mode
when the timer state is set to signaled. If fResume is TRUE on a platform that does not support a restore, the call will succeed,
but GetLastError returns ERROR_NOT_SUPPORTED.
Return Value
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error
information, call GetLastError.
Remarks
Timer are initially inactive. Timers are activated by calling SetWaitableTimer. If the timer is already active when you call SetWaitableTimer, the timer is stopped, then it is reactivated. Stopping the timer in this
manner does not set the timer state to signaled, so threads blocked in a wait
operation on the timer remain blocked.
When the specified due time arrives, the timer becomes inactive. The state of
the timer is set to signaled, the timer is reactivated using the specified
period, and the thread calls the completion routine. If you call SetWaitableTimer and the thread is not in an alertable state, the completion routine is
canceled.
When a manual-reset timer is set to the signaled state, it remains in this
state until SetWaitableTimer is called to reset the timer. As a result, a periodic manual-reset timer is
set to the signaled state when the initial due time arrives and remains signaled
until it is canceled or reset. When a synchronization timer is set to the
signaled state, it remains in this state until a thread completes a wait operation
on the timer object.
See Also
CancelWaitableTimer, CreateWaitableTimer, FILETIME, OpenWaitableTimer
| Last news from Greatis Software |
 |
|
Nostalgia .Net |
|
.Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More » |
| Recommended software for developers |
 |
|
Ultimate Pack |
|
Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More » |
 |
|
Form Designer .Net |
|
Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More » |
 |
|
Print Suite .Net |
|
Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More » |
 |
|
Gradient Controls .Net |
|
Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More » |
 |
|
Greatis iGrid |
|
iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More » |
All the contacts and projectsDmitry Vasiliev (just.dmitry)
Related LinksSoftware for Visual Studio .NET developers
Software for Delphi and C++ Builder developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET More Online Helps Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages
|
