Repository.Task.GetAllScheduledTasks: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter) |
||
| Line 2: | Line 2: | ||
<onlyinclude>Gets a list of scheduled tasks associated with a project | <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 == | == Syntax == | ||
.'''Task.GetAllScheduledTasks()''' | .'''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 Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only. | |||
| Line 17: | Line 21: | ||
{{APIComment|...}} | {{APIComment|...}} | ||
{{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) | ||
Revision as of 00:15, 1 March 2016
 |
Member of: SynthesisAPI.Repository
Gets a list of scheduled tasks associated with a project. Returns a cScheduledTask object array that contains the scheduled tasks in that 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 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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 elements in the array. Dim NumberofElements As Integer NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1 MsgBox (NumberofElements)