Repository.Task.GetAllScheduledTasks: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetAllScheduledTasks.Cmt}}


==Syntax==
*GetAllScheduledTasks(){{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]]()


== Usage Example ==
<onlyinclude>Returns an array of '''[[CScheduledTask Class|cScheduledTask]]''' objects that represent the scheduled tasks in the current project.</onlyinclude>
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
.'''Task.GetAllScheduledTasks'''(''Filter'')
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
===Parameters===
  Dim Success As Boolean = False
''Filter''
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
: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.
 
 
  {{APIComment|'Get the list of scheduled tasks from the current project.}}
 
  Dim ListOfScheduledTasks() As [[cScheduledTask Class|cScheduledTask]]
== Example ==
  ListOfScheduledTasks = MyRepository.GetAllScheduledTasks()
This example assumes that scheduled tasks exist in the first available project of a repository.
</div>
 
'''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

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"