Repository.Task.UpdateScheduledTask

Member of: SynthesisAPI.Repository

Applies any changes made to an existing scheduled task. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Task.UpdateScheduledTask(task)

Parameters

task

Required. The cScheduledTask object to be updated.

Example

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

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

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

 'Apply the change to the task. Changes are recorded in the Synthesis repository. 
 Call MyRepository.Task.UpdateScheduledTask(MyTask)

VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

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

 'Apply the change to the task. Changes are recorded in the Synthesis repository. 
 MyRepository.Task.UpdateScheduledTask(MyTask)