Repository.Task.GetAllScheduledTasks: Difference between revisions
Jump to navigation
Jump to search
Albert Szeto (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} == Method Syntax== {{APIName|GetAllScheduledTasks()}} {{APIPrefix|As}} {{APIName|cScheduledTask()}}<br…') |
Kate Racaza (talk | contribs) No edit summary |
||
(21 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{Template: | {{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> | |||
== Syntax == | |||
.'''Task.GetAllScheduledTasks'''(''Filter'') | |||
{{APIComment|Get | ===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. | |||
== Example == | |||
This example assumes that scheduled tasks exist in the first available project of a repository. | |||
'''VBA|VB.NET''' | |||
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{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 scheduled tasks in the project.}} | |||
{{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | |||
NumberofElements = UBound(ListofTasks) - LBound(ListofTasks) + 1 | |||
MsgBox (NumberofElements) |
Latest revision as of 18:54, 9 June 2016
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)