Repository.Task.GetAllScheduledTasks: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}




Line 5: Line 5:


== Syntax ==
== Syntax ==
''object''.'''Task.GetAllScheduledTasks()'''
.'''Task.GetAllScheduledTasks()'''
 
where ''object'' is a variable that represents a Repository object.




Line 15: Line 13:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
{{APIComment|'Add code to connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIComment|...}}
   
   
  {{APIComment|'Get a list of all scheduled tasks in project #1.}}
  {{APIComment|'Get a list of all scheduled tasks in project #1.}}

Revision as of 20:23, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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

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