Repository.Task.AddScheduledTask

From ReliaWiki
Revision as of 17:34, 9 June 2016 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new scheduled task 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 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)