CScheduledTask.OnCondGetTeams Method: Difference between revisions
Jump to navigation
Jump to search
(Created page with '{{DISPLAYTITLE:cScheduledTask.OnCondGetTeams Method}}{{Template:API}}{{Template:APIBreadcrumb|.cScheduledTask}} <onlyinclude>Returns an array teams req…') |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 16: | Line 16: | ||
== Example == | == Example == | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr19"}}) | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIComment|'Get a particular task with ID of 2 from repository.}} | |||
{{APIPrefix|Dim}} aTask {{APIPrefix|As}} cScheduledTask | |||
{{APIPrefix|Set}} aTask = MyRespository.Task.GetScheduledTask(2) | |||
{{APIComment|'Create instance of TeamInfo if on condition task}} | |||
{{APIPrefix|If}} aTask.TaskClass = TaskClassEnum_OnCondition {{APIPrefix|Then}} | |||
{{APIPrefix|Dim}} Teams() {{APIPrefix|As}} TeamInfo | |||
{{APIPrefix|Call}} aTask.OnCondGetTeams(Teams) | |||
{{APIPrefix|End If}} | |||
Latest revision as of 18:27, 14 March 2019
 |
Member of: SynthesisAPI.cScheduledTask
Returns an array teams required for the 'On condition' task.
Remarks: Designed for VB6/VBA users, but can also be used in .NET. Alternatively, .NET users can use the OnCondTeams() property in the class to get or set the teams.
Syntax
.OnCondGetTeams(ByRef arr())
Parameters
arr()
- Required as TeamInfo. An array of the team IDs for the task.
Example
VBA 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr19") MyRepository.Project.SetCurrentProject(1) 'Get a particular task with ID of 2 from repository. Dim aTask As cScheduledTask Set aTask = MyRespository.Task.GetScheduledTask(2) 'Create instance of TeamInfo if on condition task If aTask.TaskClass = TaskClassEnum_OnCondition Then Dim Teams() As TeamInfo Call aTask.OnCondGetTeams(Teams) End If