Talk:Repository.Task.GetAllScheduledTasks/Notes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '<onlyinclude>Gets a list of scheduled tasks associated with a project. Returns a '''cScheduledTask''' object array that contains the scheduled tasks in t…')
 
(Applied V10.1 updates to main topic)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<onlyinclude>Gets a list of scheduled tasks associated with a project. Returns a '''[[CScheduledTask Class|cScheduledTask]]''' object array that contains the scheduled tasks in that project.</onlyinclude>


== Syntax ==
.'''Task.GetAllScheduledTasks'''(''Filter'')
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of task resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local tasks only.
== Example ==
This example assumes that scheduled tasks exist in the first available project of a repository.
'''VBA|VB.NET'''
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
{{APIComment|'Get a list of all local scheduled tasks in project #1.}}
  {{APIPrefix|Dim}} ListofTasks() {{APIPrefix|As}} cScheduledTask
  MyRepository.Project.SetCurrentProject (1) 
  ListofTasks = MyRepository.Task.GetAllScheduledTasks()
{{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1
  MsgBox (NumberofElements)

Latest revision as of 15:44, 1 March 2016