Repository.UpdateScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.UpdateScheduledTask" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}
Updates the scheduled task
{{Template:Repository.UpdateScheduledTask.Cmt}} {{Template:BooleanReturn.Cmt}}
== Method Syntax  ==
{{APIName|'''UpdateScheduledTask'''(}}
{{APIPrefix|ByVal}}
{{APIName|task()}}
{{APIPrefix|As}}
{{APIName|[[cScheduledTask Class|cScheduledTask]]}}
{{APIPrefix|) As Boolean}}<br>
{{APIComment|Updates the scheduled task in the repository.}}


== Parameters ==
== Syntax  ==
'''task'''
*UpdateScheduledTask( task{{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}}
{{APIComment|The scheduled task to update in the repository.}}
 
Parameters
:''task'': The [[cScheduledTask Class|cScheduledTask]] to update.


== Usage Example ==
== Usage Example ==

Revision as of 18:26, 27 February 2014


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

Syntax

Parameters

task: The cScheduledTask to update.

Usage Example

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")

Get the list of scheduled tasks in the connected repository from the current project.

       Dim ListOfScheduledTasks() As cScheduledTask
       ListOfScheduledTasks = MyRepository.GetAllScheduledTasks()

After updating the task, update the repository

       Dim SuccessUpdateScheduledTask As Boolean = False
       SuccessUpdateScheduledTask = MyRepository.UpdateScheduledTask(ListOfScheduledTasks(0))