Repository.Task.GetAllTaskTypes: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude> | ||
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. | 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. | ||
| Line 6: | Line 7: | ||
<noinclude> | <noinclude> | ||
== Syntax == | == Syntax == | ||
' | '''.Task.GetAllTaskTypes()''' | ||
== Example == | == Example == | ||
| Line 15: | Line 15: | ||
'''VBA|VB.NET''' | '''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 task types in the repository.}} | {{APIComment|'Get a list of all 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 | {{APIComment|'Output sample: Display the name and classification ID of the first available task in the project.}} | ||
{{APIPrefix|Dim}} TaskTypeName {{APIPrefix|As}} String | {{APIPrefix|Dim}} TaskTypeName {{APIPrefix|As}} String | ||
{{APIPrefix|Dim}} TaskTypeID {{APIPrefix|As}} Integer | {{APIPrefix|Dim}} TaskTypeID {{APIPrefix|As}} Integer | ||
TaskTypeName = ListofTaskTypes(0).Name | TaskTypeName = ListofTaskTypes(0).Name | ||
TaskTypeID = ListofTaskTypes(0).Classification | TaskTypeID = ListofTaskTypes(0).Classification | ||
MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", ID#"}} & TaskTypeID) | MsgBox ({{APIString|"The first task type is: "}} & TaskTypeName & {{APIString|", Classification ID#"}} & TaskTypeID) | ||
</noinclude> | </noinclude> | ||
Revision as of 20:36, 20 July 2015
 |
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)