Repository.UpdateScheduledTask: Difference between revisions

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


== Usage Example ==
== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
{{APIComment|'Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository
  Dim MyRepository As New Repository
 
 
{{APIComment|Connect to the Synthesis repository.}}
{{APIComment|'Connect to the Synthesis repository.}}
        Dim Success As Boolean = False
  Dim Success As Boolean = False
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
{{APIComment|Get the list of scheduled tasks in the connected repository from the current project.}}
{{APIComment|'Get the list of scheduled tasks from the current project.}}
        Dim ListOfScheduledTasks() As [[cScheduledTask Class|cScheduledTask]]
  Dim ListOfScheduledTasks() As [[cScheduledTask Class|cScheduledTask]]
        ListOfScheduledTasks = MyRepository.GetAllScheduledTasks()
  ListOfScheduledTasks = MyRepository.GetAllScheduledTasks()
 
 
{{APIComment|After updating the task, update the repository}}
{{APIComment|'After updating the task, update the repository.}}
        Dim SuccessUpdateScheduledTask As Boolean = False
  Dim SuccessUpdateScheduledTask As Boolean = False
        SuccessUpdateScheduledTask = MyRepository.UpdateScheduledTask(ListOfScheduledTasks(0))
  SuccessUpdateScheduledTask = MyRepository.UpdateScheduledTask(ListOfScheduledTasks(0))

Revision as of 22:48, 23 May 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. 
 Dim MyRepository As New Repository
 
 'Connect to the Synthesis repository. 
 Dim Success As Boolean = False
 Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 'Get the list of scheduled tasks 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))