Repository.Task.AddScheduledTask: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude> | ||
Saves a new [[CScheduledTask Class|cScheduledTask]] object to the | |||
Saves a new [[CScheduledTask Class|cScheduledTask]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save. | |||
<noinclude> | <noinclude> | ||
If a task with the same name already exists in the current project, the application will automatically increment the name. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc. | |||
== Syntax == | == Syntax == | ||
' | '''.Task.AddScheduledTask'''(''task'') | ||
=== Parameters === | === Parameters === | ||
''task'' | |||
:The [[CScheduledTask Class|cScheduledTask]] object to be added. (Required) | |||
== Example == | == Example == | ||
This example creates a new scheduled task resource, and then saves it in the first available project in a Synthesis repository. | |||
'''VBA''' | '''VBA''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Create a new scheduled task. The following example creates a task named "MyNewTask."}} | {{APIComment|'Create a new scheduled task. The following example creates a task named "MyNewTask."}} | ||
| Line 31: | Line 31: | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}} | {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}} | ||
Revision as of 18:52, 20 July 2015
 |
Member of: SynthesisAPI10.Repository
Saves a new cScheduledTask object to the current project. Returns a Boolean value; when true, indicates a successful save.
If a task with the same name already exists in the current project, the application will automatically increment the name. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.
Syntax
.Task.AddScheduledTask(task)
Parameters
task
- The cScheduledTask object to be added. (Required)
Example
This example creates a new scheduled task resource, and then saves it in the first available project in a Synthesis repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Create a new scheduled task. The following example creates a task named "MyNewTask." Dim NewTask As New cScheduledTask NewTask.Name = "MyNewTask" 'Add the new task to project #1. The task will be visible in the Synthesis repository upon refresh. MyRepository.Project.SetCurrentProject(1) Call MyRepository.Task.AddScheduledTask(NewTask)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Create a new corrective task. The following example creates a corrective task named "MyNewTask." Dim NewTask As New cScheduledTask ("MyNewTask") 'Add the new task to project #1. The task will be visible in the Synthesis repository upon refresh. MyRepository.Project.SetCurrentProject(1) MyRepository.Task.AddScheduledTask(NewTask)