Skip to main content

CtrlBackground

CtrlBackground [start[=startTicks ], period=deltaTicks, dialogsOK=d, noBurst=n, stop]

The CtrlBackground operation controls the unnamed background task.

CtrlBackground works only with the unnamed background task. New code should used named background tasks instead. See Background Tasks for details.

Parameters

period=deltaTicksSets the minimum number of ticks that must pass between invocations of the background task.
dialogsOK=1 or 0If 1, your task will be allowed to run while an Igor dialog is present. This can potentially cause crashes unless your task is well behaved.
noBurst=1 or 0Normally (or noBurst=0), your task will be called at maximum rate if a delay misses normal run times. Using noBurst=1, will suppress this burst catch up mode.
start[=startTicks ]Starts the background task (designated by SetBackground) when the tick count reaches startTicks. If you omit startTicks the task starts immediately.
stopStops the background task.

See Also

SetBackground, KillBackground, CtrlNamedBackground, BackgroundInfo

Background Tasks