Repository.Task.GetAllScheduledTasks: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.GetAllScheduledTasks.Cmt}}


==Syntax==
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.
*GetAllScheduledTasks(){{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]]()
<noinclude>
== Syntax ==
''object''.'''Task.GetAllScheduledTasks()'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
 
  Dim MyRepository As New Repository
== Example ==
 
This example assumes that scheduled tasks exist in the first available project of a repository.
  {{APIComment|'Connect to the Synthesis repository.}}
 
  Dim Success As Boolean = False
'''VBA|VB.NET'''
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
   
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIComment|'Get a list of all scheduled tasks in project #1.}}
  {{APIPrefix|Dim}} ListofTasks() {{APIPrefix|As}} cScheduledTask
   MyRepository.Project.SetCurrentProject (1) 
  ListofTasks = MyRepository.Task.GetAllScheduledTasks()
   
   
  {{APIComment|'Get the list of scheduled tasks from the current project.}}
  {{APIComment|'Output sample: Display the name and ID of the first available scheduled task in the project.}}
   Dim ListOfScheduledTasks() As [[cScheduledTask Class|cScheduledTask]]
   {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
   ListOfScheduledTasks = MyRepository.Task.GetAllScheduledTasks()
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
</div>
   TaskName = ListofTasks(0).Name
  TaskID = ListofTasks(0).ID
  MsgBox ({{APIString|"The first scheduled task is: "}} & TaskName & {{APIString|", ID#"}} & TaskID)
</noinclude>

Revision as of 18:22, 16 July 2015

APIWiki.png


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.GetAllScheduledTasks&oldid=59430"