Repository.Task.AddScheduledTask: Difference between revisions

Revision as of 18:23, 27 February 2014

Saves the scheduled task in the repository. Returns True if successful, otherwise returns False.

Parameters

task: The cScheduledTask to add.

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Declare a new cScheduledTask.

       Dim newScheduledTask As New cScheduledTask("NewScheduledTask1")

After creating the task, update the repository

       Dim SuccessAddScheduledTask As Boolean = False
       SuccessAddScheduledTask = MyRepository.AddScheduledTask(newScheduledTask)

@@ Line 1: / Line 1: @@
 {{Template:APIClass|Repository Class|Repository}}
-Adds the scheduled task
+{{Template:Repository.AddScheduledTask.Cmt}} {{Template:BooleanReturn.Cmt}}
-== Method Syntax==
-{{APIName|'''AddScheduledTask'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|task()}}
-{{APIPrefix|As}}
-{{APIName|[[cScheduledTask Class|cScheduledTask]]}}
-{{APIPrefix|) As Boolean}}<br>
-{{APIComment|Saves the scheduled task in the repository.}}
-== Parameters ==
+==Syntax==
-'''task'''
+*AddScheduledTask( task(){{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}}
-{{APIComment|The new scheduled task to add to the repository.}}
+Parameters
+:''task'': The [[cScheduledTask Class|cScheduledTask]] to add.
 == Usage Example ==