JCL Help:TJclMultimediaTimer.WaitFor
JCL Help: TJclMultimediaTimer.WaitFor Method
Search in JCL Help
Search in all projects
Summary
Waits for the event to become signaled.
Pascal
public function WaitFor(const TimeOut: Cardinal): TJclWaitResult;
Parameters
| Parameters | Description |
| const TimeOut: Cardinal | Timeout in milliseconds. If the event doesn't become signaled before the timeout expires, the function aborts the wait and returns wrTimeOut. |
Return Value
If the event became signaled before the timeout elapsed, the return value is wrSignaled. Other values indicate some kind of error. See TJclWaitResult for the details.
Description
WaitFor is only used when the timer's notification method is set to either nkSetEvent or nkPulseEvent. After calling BeginTimer the timer will set an event when the interval expires. You wait for the interval to expire by waiting on that event using this method. Note that in case of an nkSetEvent timer you must use the Event property to call the ResetEvent when the event becomes signaled. For all other purposes you should leave the Event property alone.
About
Donator
Marcel van Brakel
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
