SCHED: GetTaskInfoOpts
Format
SCHED / GetTaskInfoOpts '<TaskName>' '<FileName>' OptionList
Description
The SCHED GetTaskInfoOpts Connect command returns some of the attributes of the task specified by the <TaskName> parameter. The function of this command is mostly identical to the "SCHED GetTaskInfo" command, except that the only data returned is the data specified in the "OptionList".
Parameters
- TaskName: The parameter is a string of text in single quotes of a comma delimited list of tasks. Task names should not be in quotes. Supports the use of wildcards.
- FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if the command does not write out to a file.
- OptionList: One or more strings specifying what fields should be in the report. There are many fields available. The strings should match the detail labels described in the Task Report page. If the OptionsList is empty, the full report is returned. Note that the options should not be enclosed by quotes.
Examples
Finds out the values of name, FOM, and groups attributes of the SSRDump task in the active schedule and save them
to the file "out.txt" located at "C:\Outputs\"
SCHED / GetTaskInfoOpts 'SSRDump' 'C:\Outputs\out.txt' TR_TASK_NAME TR_FOM_TOTAL
TR_GROUPS
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / GetTaskInfoOpts |
| <TaskName> | 'SSRDump' |
| <FileName> | 'C:\Outputs\out.txt' |
| <OptionList> | TR_TASK_NAME TR_FOM_TOTAL TR_GROUPS |
Return Message
Connect returns a message that contains all of the attribute data for the task. The report matches the format specified on the Task Report page.
ACK
Group Membership
This command belongs to the following group(s):
Version
11.5
