Repository.Task.GetAllTaskTypes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Gets all the task types in the connected repository
== Method Syntax  ==
{{APIName|'''GetAllTaskTypes'''()}}
{{APIPrefix|) As [[TaskTypeInfo Class|TaskTypeInfo]]}}<br>
{{APIComment|Gets all the task types in the connected repository.}}


== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
<onlyinclude>Returns an array of '''[[TaskTypeInfo Class|TaskTypeInfo]]''' objects that represent the RCM++ or RBI task types associated with the <code>Repository</code> object.</onlyinclude>
        Dim Success As Boolean = False
 
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
== Syntax ==
'''.Task.GetAllTaskTypes()'''


{{APIComment|Get the list of scheduled tasks in the connected repository from the current project.}}
 
        Dim ListOfTaskTypes() As [[TaskTypeInfo Class|TaskTypeInfo]]
== Example ==
        ListOfTaskTypes = MyRepository.GetAllTaskTypes()
This example assumes that task types have been defined in the Synthesis 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 defined task types in the repository.}}
  {{APIPrefix|Dim}} ListofTaskTypes() {{APIPrefix|As}} TaskTypeInfo
  ListofTaskTypes = MyRepository.Task.GetAllTaskTypes()
{{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofTaskTypes) - LBound(ListofTaskTypes) + 1
  MsgBox (NumberofElements)

Latest revision as of 21:40, 24 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of TaskTypeInfo objects that represent the RCM++ or RBI task types associated with the Repository object.

Syntax

.Task.GetAllTaskTypes()


Example

This example assumes that task types have been defined in the Synthesis repository. 

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ...   

 
 'Get a list of all defined task types in the repository. 
 Dim ListofTaskTypes() As TaskTypeInfo
 ListofTaskTypes = MyRepository.Task.GetAllTaskTypes()

 'Output sample: Display the number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofTaskTypes) - LBound(ListofTaskTypes) + 1
 MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.GetAllTaskTypes&oldid=64438"