SCHED: LockTasks
Format
SCHED / LockTasks <Attribute1Name> <Attribute2Name> <Parameter>
Description
The SCHED LockTasks Connect command can be used to either Lock or UnLock specified tasks or all assigned tasks. Tasks may be specified either by their name, priority value, group membership, or by their assigned time.
| {Attribute1Name} | {Attribute2Name} | <Parameters> | Parameters Values |
|---|---|---|---|
| Lock or UnLock | Names | '<TaskList>' | <TaskList> is a comma delimited list of tasks. This value must be in single quotes. Do not encapsulate Task names in double quotes. |
| Lock or UnLock | Priority | <Min Priority> <Max Priority> | <Min Priority> is the minimum priority value for tasks that will be effected by this command. -1
may be used to specify that there is no lower boundary. <Max Priority> is the maximum priority value for tasks that will be effected by this command. -1 may be used to specify that there is no upper boundary. |
| Lock or UnLock | Groups | '<GroupList>' | <GroupList> is a comma delimited list of group names. This value must be in single quotes. Do not encapsulate Group names in double quotes. |
| Lock or UnLock | Times | <Start Time> <Stop Time> | <Start Time> is the beginning of the time window that will be used to specify tasks that will be
affected by this command. <Stop Time> is the end of the time window used to specify tasks that will be affected by this command. Any assigned tasks that fall partially or entirely between the defined Start and Stop Times will be affected. Time Formats are YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff |
| Lock or UnLock | All | NA | Locks or unlocks all assigned tasks |
Examples
Locks tasks called: DemoTask1 and DemoTask2
SCHED / LockTasks Lock Names 'DemoTask1,
DemoTask2'
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / LockTasks |
| {Attribute1Name} | Lock |
| {Attribute2Name} | Names |
| <Parameters> | 'DemoTask1, DemoTask2' |
Return Message
If activated, connect returns an acknowledgment message.
Group Membership
This command belongs to the following group(s):
Version
5.0
