Repository.Task.GetAllTaskTypes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


Gets a list of all existing task types in the current repository. Returns a '''[[TaskTypeInfo Class|TaskTypeInfo]]''' object array that contains the definitions, ID numbers, classifications and abbreviations. 


Applies only to RCM++ and RBI. In Synthesis desktop applications, the task types are shown in the Define Task Types window.
<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>
<noinclude>
 
== Syntax ==
== Syntax ==
''object''.'''Task.GetAllTaskTypes()'''
'''.Task.GetAllTaskTypes()'''


where ''object'' is a variable that represents a Repository object.


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


  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}   
   
   
  {{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 of the first available preventive 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|", ID#"}} & TaskTypeID)
</noinclude>

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"