Repository.Task.GetAllScheduledTasks

Member of: SynthesisAPI10Repository

Gets a list of all existing scheduled tasks in the current project. Returns a cScheduledTask object array that contains the task names, ID numbers and other information.

Syntax

object.Task.GetAllScheduledTasks()

where object is a variable that represents a Repository object.

Example

This example assumes that scheduled tasks exist in the first available project of a repository.

VBA|VB.NET

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

 'Get a list of all scheduled tasks in project #1. 
 Dim ListofTasks() As cScheduledTask
 MyRepository.Project.SetCurrentProject (1)  
 ListofTasks = MyRepository.Task.GetAllScheduledTasks()

 'Output sample: Display the name and ID of the first available scheduled task in the project. 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = ListofTasks(0).Name
 TaskID = ListofTasks(0).ID
 MsgBox ("The first scheduled task is: " & TaskName & ", ID#" & TaskID)