Repository.Task.GetCorrectiveTask: 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>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
 


Gets the corrective task with the designated ID number and returns it as a '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object. Returns nothing if the task does not exist or is not in the current project.  
Gets the corrective task with the designated ID number and returns it as a '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object. Returns nothing if the task does not exist or is not in the current project.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Task.GetCorrectiveTask(''ID'')'''
'''.Task.GetCorrectiveTask'''(''ID'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Integer. The ID number of the corrective task to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the corrective task to retrieve.
|}




Line 19: Line 15:
  '''VBA'''
  '''VBA'''
   
   
  {{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 corrective task #1 from project #1.}}
  {{APIComment|'Get corrective task #1 from project #1.}}
Line 36: Line 34:
  '''VB.NET'''
  '''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 corrective task #1 from project #1.}}
  {{APIComment|'Get corrective task #1 from project #1.}}

Revision as of 20:42, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the corrective task with the designated ID number and returns it as a cCorrectiveTask object. Returns nothing if the task does not exist or is not in the current project.

Syntax

.Task.GetCorrectiveTask(ID)

Parameters

ID

Integer. The ID number of the corrective task to retrieve.


Example

This example assumes that a corrective task with ID#1 exists in a repository.

VBA

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


 'Get corrective task #1 from project #1. 
 Dim MyTask As cCorrectiveTask
 MyRepository.Project.SetCurrentProject(1)
 Set MyTask = MyRepository.Task.GetCorrectiveTask(1)

 'Output sample: Display the name and ID of the task. 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = MyTask.Name
 TaskID = MyTask.ID
 MsgBox ("You got " & TaskName & ", ID#" & TaskID)
VB.NET

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

 'Get corrective task #1 from project #1. 
 Dim MyTask As cCorrectiveTask
 MyRepository.Project.SetCurrentProject(1)
 MyTask = MyRepository.Task.GetCorrectiveTask(1)

 'Output sample: Display the name and ID of the task. 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = MyTask.Name
 TaskID = MyTask.ID
 MsgBox ("You got " & TaskName & ", ID#" & TaskID)