Repository.Task.GetAllTaskTypes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|10|.[[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.
<onlyinclude>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.</onlyinclude> 


Applies only to RCM++ and RBI. In Synthesis desktop applications, the task types are shown in the Define Task Types window.
Applies only to RCM++ and RBI. In Synthesis desktop applications, the task types are shown in the Define Task Types window.
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Task.GetAllTaskTypes()'''
  '''.Task.GetAllTaskTypes()'''
Line 30: Line 30:
   TaskTypeID = ListofTaskTypes(0).Classification
   TaskTypeID = ListofTaskTypes(0).Classification
   MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", Classification ID#"}} & TaskTypeID)
   MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", Classification ID#"}} & TaskTypeID)
</noinclude>

Revision as of 20:25, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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

.Task.GetAllTaskTypes()


Example

This example assumes that task types exist in the repository.

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New 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 ID of the first available 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 & ", Classification ID#" & TaskTypeID)