Repository.Task.GetAllScheduledTasks: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a list of all existing scheduled tasks in the current project. Returns a '''[[CScheduledTask Class|cScheduledTask]]''' object array that contains the task names, ID numbers and other information.</onlyinclude>  
<onlyinclude>Gets a list of scheduled tasks associated with a project. Returns a '''[[CScheduledTask Class|cScheduledTask]]''' object array that contains all the scheduled tasks in that project.</onlyinclude>  


== Syntax ==
== Syntax ==
Line 22: Line 22:
   ListofTasks = MyRepository.Task.GetAllScheduledTasks()
   ListofTasks = MyRepository.Task.GetAllScheduledTasks()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available scheduled task in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1
   TaskName = ListofTasks(0).Name
   MsgBox (NumberofElements)
  TaskID = ListofTasks(0).ID
   MsgBox ({{APIString|"The first scheduled task is: "}} & TaskName & {{APIString|", ID#"}} & TaskID)

Revision as of 22:46, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of scheduled tasks associated with a project. Returns a cScheduledTask object array that contains all the scheduled tasks in that project.

Syntax

.Task.GetAllScheduledTasks()


Example

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

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
 Dim MyRepository As New 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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1
 MsgBox (NumberofElements)