Repository.Task.GetScheduledTask

Member of: SynthesisAPI10Repository

Gets the scheduled task with the designated ID number and returns it as a cScheduledTask object. Returns nothing if the task does not exist or is not in the current project.

Syntax

.Task.GetScheduledTask(ID)

Parameters

ID

Required. Integer. The ID number of the scheduled task to retrieve.

Example

This example assumes that a scheduled task with ID #1 exists in the first project of a Synthesis 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)

 'Output sample: Display the name and ID of the task. 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = MyTask.Name
 TaskID = MyTask.ID
 MsgBox ("You got " & TaskName & ", ID#" & TaskID)

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)

 'Output sample: Display the name and ID of the task. 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = MyTask.Name
 TaskID = MyTask.ID
 MsgBox ("You got " & TaskName & ", ID#" & TaskID)