BackgroundInfo
BackgroundInfo
The BackgroundInfo operation returns information about the current unnamed background task.
BackgroundInfo works only with the unnamed background task. New code should used named background tasks instead. See Background Tasks for details.
Details
The information is returned via the following variables:
| V_flag | 0: | If no background task is defined. | ||
| 1: | A background task is defined, but not running (is idle). | |||
| 2: | A background task is defined and is running. | |||
| V_period | The deltaTicks value set by CtrlBackground. This is how often the background task runs. | |||
| V_nextRun | The ticks value when the task will run again. 0 if the task is not scheduled to run again. | |||
| S_value | The text of the numeric expression that the background task executes, as set by SetBackground. | |||