Repository.Task.GetAllScheduledTasks: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Returns an array of '''[[CScheduledTask Class|cScheduledTask]]''' objects that represent the scheduled tasks in the current project.</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.
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Task.GetAllScheduledTasks()'''
.'''Task.GetAllScheduledTasks'''(''Filter'')


where ''object'' is a variable that represents a Repository object.
===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 Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.  




Line 14: Line 17:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
   
  {{APIComment|'Get a list of all scheduled tasks in project #1.}}
  {{APIComment|'Get a list of all local scheduled tasks in project #1.}}
  {{APIPrefix|Dim}} ListofTasks() {{APIPrefix|As}} cScheduledTask
  {{APIPrefix|Dim}} ListofTasks() {{APIPrefix|As}} cScheduledTask
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  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 scheduled tasks in the project.}}
  {{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)
</noinclude>

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