Repository.Task.GetScheduledTask

Member of: SynthesisAPI.Repository

Gets a cScheduledTask object that represents a given scheduled task resource in the current project. 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

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

 '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

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

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