Difference between revisions of "Repository.Task.GetAllScheduledTasks"

From ReliaWiki
Jump to navigation Jump to search
 
Line 2: Line 2:
  
  
<onlyinclude>Gets an array of '''[[CScheduledTask Class|cScheduledTask]]''' objects that represent the scheduled tasks in the current project.</onlyinclude>  
+
<onlyinclude>Returns an array of '''[[CScheduledTask Class|cScheduledTask]]''' objects that represent the scheduled tasks in the current project.</onlyinclude>  
  
 
== Syntax ==
 
== Syntax ==

Latest revision as of 18:54, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cScheduledTask objects that represent the scheduled tasks in the current project.

Syntax

.Task.GetAllScheduledTasks(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

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

 'Output sample: Display the number of scheduled tasks in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1
  MsgBox (NumberofElements)