Repository.Task.AddScheduledTask: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) mNo edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
<onlyinclude> | <onlyinclude>Adds a new scheduled task to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> | ||
'''Remarks''': If a task with the same name already exists in the project, the name will be incremented automatically. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc. | |||
== Syntax == | == Syntax == | ||
'''.Task.AddScheduledTask'''(''task'') | '''.Task.AddScheduledTask'''(''task'') | ||
=== Parameters === | === Parameters === | ||
''task'' | ''task'' | ||
:The [[CScheduledTask Class|cScheduledTask]] object to be added. | :Required. The [[CScheduledTask Class|cScheduledTask]] object that represents the scheduled task to be added. | ||
| Line 16: | Line 19: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|' | {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{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."}} | ||
{{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask | |||
NewTask.Name = {{APIString|"MyNewTask"}} | |||
{{APIComment|'Add the new task to project #1 | {{APIComment|'Add the new task to project #1.}} | ||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Call}} MyRepository.Task.AddScheduledTask(NewTask) | |||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{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."}} | ||
{{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask ({{APIString|"MyNewTask"}}) | |||
{{APIComment|'Add the new task to project #1 | {{APIComment|'Add the new task to project #1.}} | ||
MyRepository.Project.SetCurrentProject(1) | |||
MyRepository.Task.AddScheduledTask(NewTask) | |||
Latest revision as of 20:36, 18 August 2016
 |
Member of: SynthesisAPI.Repository
Adds a new scheduled task to the current project. Returns a Boolean value; when true, indicates a successful save.
Remarks: If a task with the same name already exists in the project, the name will be incremented automatically. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.
Syntax
.Task.AddScheduledTask(task)
Parameters
task
- Required. The cScheduledTask object that represents the scheduled task to be added.
Example
This example creates a new scheduled task resource, and then saves it in the first available project in a Synthesis repository.
VBA 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") '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. MyRepository.Project.SetCurrentProject(1) Call MyRepository.Task.AddScheduledTask(NewTask)
VB.NET 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") '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. MyRepository.Project.SetCurrentProject(1) MyRepository.Task.AddScheduledTask(NewTask)