Repository.Task.GetAllTaskTypes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a list of all existing RCM++ or RBI task types in the current repository. Returns a '''[[TaskTypeInfo Class|TaskTypeInfo]]''' object array that contains the definitions, ID numbers, classifications and abbreviations.</onlyinclude>
<onlyinclude>Gets a list of RCM++ or RBI task types associated with a Synthesis repository. Returns a '''[[TaskTypeInfo Class|TaskTypeInfo]]''' object array that contains all the defined task types in that repository.</onlyinclude>
    
    
== Syntax ==
== Syntax ==
Line 9: Line 9:


== Example ==
== Example ==
This example assumes that task types exist in the repository.
This example assumes that task types have been defined in a Synthesis repository.


  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
Line 18: Line 18:
   
   
    
    
  {{APIComment|'Get a list of all task types in the repository.}}
  {{APIComment|'Get a list of all defined task types in the repository.}}
   {{APIPrefix|Dim}} ListofTaskTypes() {{APIPrefix|As}} TaskTypeInfo
   {{APIPrefix|Dim}} ListofTaskTypes() {{APIPrefix|As}} TaskTypeInfo
   ListofTaskTypes = MyRepository.Task.GetAllTaskTypes()
   ListofTaskTypes = MyRepository.Task.GetAllTaskTypes()
   
   
  {{APIComment|'Output sample: Display the name and classification ID of the first available task in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} TaskTypeName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} TaskTypeID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofTaskTypes) - LBound(ListofTaskTypes) + 1
   TaskTypeName = ListofTaskTypes(0).Name
   MsgBox (NumberofElements)
  TaskTypeID = ListofTaskTypes(0).Classification
   MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", Classification ID#"}} & TaskTypeID)

Revision as of 23:25, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of RCM++ or RBI task types associated with a Synthesis repository. Returns a TaskTypeInfo object array that contains all the defined task types in that repository.

Syntax

.Task.GetAllTaskTypes()


Example

This example assumes that task types have been defined in a 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)