Repository.Task.AddScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Saves a new [[CScheduledTask Class|cScheduledTask]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
<onlyinclude>Adds a new scheduled task to a Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
 
If a task with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.


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'')
  '''.Task.AddScheduledTask'''(''task'')
=== Parameters ===
=== Parameters ===
''task''
''task''
:The [[CScheduledTask Class|cScheduledTask]] object to be added. (Required)
:Required. The [[CScheduledTask Class|cScheduledTask]] object to be added. (Required)




Line 25: Line 27:
   NewTask.Name = {{APIString|"MyNewTask"}}
   NewTask.Name = {{APIString|"MyNewTask"}}
   
   
  {{APIComment|'Add the new task to project #1. The task will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new task to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   {{APIPrefix|Call}} MyRepository.Task.AddScheduledTask(NewTask)
   {{APIPrefix|Call}} MyRepository.Task.AddScheduledTask(NewTask)
Line 39: Line 41:
   {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask ({{APIString|"MyNewTask"}})
   {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask ({{APIString|"MyNewTask"}})
   
   
  {{APIComment|'Add the new task to project #1. The task will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new task to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Task.AddScheduledTask(NewTask)
   MyRepository.Task.AddScheduledTask(NewTask)

Revision as of 21:45, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Adds a new scheduled task to a Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

If a task with the same name already exists in the destination 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 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. 
 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. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.Task.AddScheduledTask(NewTask)