Repository.Task.UpdateScheduledTask

Member of: SynthesisAPI.Repository

Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Task.UpdateScheduledTask(task)

Parameters

task

Required. The cScheduledTask object that represents the scheduled task to be updated.

Example

This example assumes that a scheduled task with ID #1 exists in the first available of a repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get scheduled task #1 from project #1. 
  Dim MyTask As cScheduledTask
  MyRepository.Project.SetCurrentProject(1)  
  Set MyTask = MyRepository.Task.GetScheduledTask(1)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Task.UpdateScheduledTask(MyTask)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get scheduled task #1 from project #1. 
  Dim MyTask As cScheduledTask
  MyRepository.Project.SetCurrentProject(1)  
  MyTask = MyRepository.Task.GetScheduledTask(1)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Task.UpdateScheduledTask(MyTask)