WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

$ScheduledTask
✖
$ScheduledTask

$ScheduledTask is being phased out in favor of $CurrentTask, which was introduced experimentally in Version 11.2.

✖
$ScheduledTask

returns within a scheduled task the ScheduledTaskObject or CloudObject for the task.

Details

  • If it is evaluated not within a scheduled task, $ScheduledTask gives None.
  • $ScheduledTask is used to refer to the task within a task evaluation, e.g. to learn the parameters or stop the task.

Examples

Basic Examples  (8)Summary of the most common use cases

Print the running scheduled task object:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-c5o4tf
Out[1]=1

Print its time specification:

In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-boit22
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-wgef6

Remove the scheduled task automatically when it is not needed:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-pto460
In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-c2oe82
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-fq79yo
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-cbjvc6
In[5]:=5
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-k9y8jd
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-o0v34

Create a task with random wait periods:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-mhphd8
In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-3luuj
In[3]:=3
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-bn1v1p
In[4]:=4
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-dgkwwx

Create a task that restarts evaluation as soon as it finishes:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-io6bn5
In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-jr7onh
In[3]:=3
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-fy76p7

Create a task that runs only once and removes itself after finishing:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-l8x0rg
In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-dnj433
Out[2]=2

Create a task that removes itself once a condition is met:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-f14vww

Create a task that removes itself when an external variable is changed:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-jq9ld8

Cause the task to be stopped and removed:

In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-cue4py
Out[2]=2

Synchronize scheduled tasks using an auxiliary task:

In[1]:=1
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-nr5on
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-cmyszo
In[3]:=3
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-fn5fyn
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-bylrwn

The auxiliary task x1 was removed:

In[5]:=5
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-cmiy3b
Out[5]=5

Stop all scheduled tasks:

In[6]:=6
✖
https://wolfram.com/xid/0dpbmr66mwjt7o9fm-d99w61
Wolfram Research (2010), $ScheduledTask, Wolfram Language function, https://reference.wolfram.com/language/ref/$ScheduledTask.html (updated 2014).
✖
Wolfram Research (2010), $ScheduledTask, Wolfram Language function, https://reference.wolfram.com/language/ref/$ScheduledTask.html (updated 2014).

Text

Wolfram Research (2010), $ScheduledTask, Wolfram Language function, https://reference.wolfram.com/language/ref/$ScheduledTask.html (updated 2014).

✖
Wolfram Research (2010), $ScheduledTask, Wolfram Language function, https://reference.wolfram.com/language/ref/$ScheduledTask.html (updated 2014).

CMS

Wolfram Language. 2010. "$ScheduledTask." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2014. https://reference.wolfram.com/language/ref/$ScheduledTask.html.

✖
Wolfram Language. 2010. "$ScheduledTask." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2014. https://reference.wolfram.com/language/ref/$ScheduledTask.html.

APA

Wolfram Language. (2010). $ScheduledTask. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$ScheduledTask.html

✖
Wolfram Language. (2010). $ScheduledTask. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$ScheduledTask.html

BibTeX

@misc{reference.wolfram_2025_$scheduledtask, author="Wolfram Research", title="{$ScheduledTask}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/$ScheduledTask.html}", note=[Accessed: 01-April-2025 ]}

✖
@misc{reference.wolfram_2025_$scheduledtask, author="Wolfram Research", title="{$ScheduledTask}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/$ScheduledTask.html}", note=[Accessed: 01-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_$scheduledtask, organization={Wolfram Research}, title={$ScheduledTask}, year={2014}, url={https://reference.wolfram.com/language/ref/$ScheduledTask.html}, note=[Accessed: 01-April-2025 ]}

✖
@online{reference.wolfram_2025_$scheduledtask, organization={Wolfram Research}, title={$ScheduledTask}, year={2014}, url={https://reference.wolfram.com/language/ref/$ScheduledTask.html}, note=[Accessed: 01-April-2025 ]}