Repository.Task.AddScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.AddScheduledTask.Cmt}} {{Template:BooleanReturn.Cmt}}


==Syntax==
*AddScheduledTask( task{{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}}


Parameters
<onlyinclude>Adds a new scheduled task to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
:''task'': The [[cScheduledTask Class|cScheduledTask]] to add.


== Usage Example ==
 
  {{APIComment|'Declare a new repository connection object.}}
'''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.
  Dim MyRepository As New Repository
 
== Syntax ==
'''.Task.AddScheduledTask'''(''task'')
 
=== Parameters ===
''task''
:Required. The [[CScheduledTask Class|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'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Create a new scheduled task. The following example creates a task named "MyNewTask."}}
  Dim Success As Boolean = False
  {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  NewTask.Name = {{APIString|"MyNewTask"}}
{{APIComment|'Add the new task to project #1.}}
  MyRepository.Project.SetCurrentProject(1) 
  {{APIPrefix|Call}} MyRepository.Task.AddScheduledTask(NewTask)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
  MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cScheduledTask ({{APIString|"MyNewTask"}})
   
   
  {{APIComment|'Declare a new cScheduledTask.}}
  {{APIComment|'Add the new task to project #1.}}
  Dim newScheduledTask As New cScheduledTask("NewScheduledTask1")
  MyRepository.Project.SetCurrentProject(1)   
 
  MyRepository.Task.AddScheduledTask(NewTask)
{{APIComment|'After creating the task, update the repository}}
   Dim SuccessAddScheduledTask As Boolean = False
  SuccessAddScheduledTask = MyRepository.Task.AddScheduledTask(newScheduledTask)

Latest revision as of 20:36, 18 August 2016

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.


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.AddScheduledTask&oldid=64614"