Repository.Task.GetAllTaskTypes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.GetAllTaskTypes.Cmt}}


== Syntax  ==
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. 
*GetAllTaskTypes(){{APIPrefix|As [[TaskTypeInfo Class|TaskTypeInfo]]}}


== Usage Example ==
Applies only to RCM++ and RBI. In Synthesis desktop applications, the task types are shown in the Define Task Types window.
<div style="margin-right: 150px;">
<noinclude>
== Syntax ==
''object''.'''Task.GetAllTaskTypes()'''


  {{APIComment|'Declare a new repository connection object.}}
where ''object'' is a variable that represents a Repository object.
  Dim MyRepository As New Repository
 
 
== Example ==
  {{APIComment|'Connect to the Synthesis repository.}}
This example assumes that task types exist in the repository.
   Dim Success As Boolean = False
 
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
'''VBA|VB.NET'''
 
  {{APIComment|'Get the list of task types from the current repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   Dim ListOfTaskTypes() As [[TaskTypeInfo Class|TaskTypeInfo]]
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
   ListOfTaskTypes = MyRepository.Task.GetAllTaskTypes()
</div>
  {{APIComment|'Get a list of all task types in the repository.}}
   {{APIPrefix|Dim}} ListofTaskTypes() {{APIPrefix|As}} TaskTypeInfo
   ListofTaskTypes = MyRepository.Task.GetAllTaskTypes()
  {{APIComment|'Output sample: Display the name and classification of the first available preventive task in the project.}}
   {{APIPrefix|Dim}} TaskTypeName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} TaskTypeID {{APIPrefix|As}} Integer
   TaskTypeName = ListofTaskTypes(0).Name
  TaskTypeID = ListofTaskTypes(0).Classification
  MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", ID#"}} & TaskTypeID)
</noinclude>

Revision as of 20:29, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Gets a list of all existing task types in the current repository. Returns a 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.

Syntax

object.Task.GetAllTaskTypes()

where object is a variable that represents a Repository object.

Example

This example assumes that task types exist in the repository. 

VBA|VB.NET

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

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

 'Output sample: Display the name and classification of the first available preventive task in the project. 
 Dim TaskTypeName As String
 Dim TaskTypeID As Integer
 TaskTypeName = ListofTaskTypes(0).Name
 TaskTypeID = ListofTaskTypes(0).Classification
 MsgBox ("The first task type is: " & TaskTypeName & ", ID#" & TaskTypeID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.GetAllTaskTypes&oldid=59431"