Method Thread():setStartTime() Foundation

Defines the start time for a thread to execute program code.

Syntax
:setStartTime( <nSeconds> ) --> lSuccess
Parameters
<nSeconds>
The numeric parameter <nSeconds> indicates the time when a thread is to start executing program code. It must be specified as "seconds since midnight". If <nSeconds> is smaller than the return value of the function Seconds(), the thread will start on the next day. Passing the value NIL voids a previously defined start time.
Return

If the start time is set, the method returns the value .T. (true), otherwise it returns .F. (false).

Description

With :setStartTime() a particular point in time can be defined for a Thread object to actually begin with the execution of program code after the :start() method is called. The Thread object delays program execution until the return value of Seconds() is larger than <nSeconds>. The value of <nSeconds> is assigned to the :startTime instance variable. If :startTime contains a smaller value than Seconds() when :start() is called, the Thread object commences program execution on the following day. When the start time is voided after being set and no program code has been executed so far, the Thread object immediately starts the thread.

If :setStartTime() is used in conjunction with :setInterval()the :setInterval() should be called in the :atStart callback slot.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.