Repository.Task.GetCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>  
<onlyinclude>Returns a '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object, which represents a corrective task resource. Returns nothing if the task does not exist or is not in the current project.</onlyinclude>  


== Syntax ==
== Syntax ==
Line 16: Line 16:
  '''VBA'''
  '''VBA'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get corrective task #1 from project #1.}}
  {{APIComment|'Get corrective task #1 from project #1.}}
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} MyTask = MyRepository.Task.GetCorrectiveTask(1)
  {{APIPrefix|Set}} MyTask = MyRepository.Task.GetCorrectiveTask(1)
   
   
  {{APIComment|'Output sample: Display the name and ID of the task.}}
  {{APIComment|'Output sample: Display the name and ID of the task.}}
  {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
  TaskName = MyTask.Name
  TaskName = MyTask.Name
  TaskID = MyTask.ID
  TaskID = MyTask.ID
  MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)
  MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get corrective task #1 from project #1.}}
  {{APIComment|'Get corrective task #1 from project #1.}}
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  MyTask = MyRepository.Task.GetCorrectiveTask(1)
  MyTask = MyRepository.Task.GetCorrectiveTask(1)
   
   
  {{APIComment|'Output sample: Display the name and ID of the task.}}
  {{APIComment|'Output sample: Display the name and ID of the task.}}
  {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
  TaskName = MyTask.Name
  TaskName = MyTask.Name
  TaskID = MyTask.ID
  TaskID = MyTask.ID
  MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)
  MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)

Revision as of 16:52, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cCorrectiveTask object, which represents a corrective task resource. Returns nothing if the task does not exist or is not in the current project.

Syntax

.Task.GetCorrectiveTask(ID)

Parameters

ID

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


Example

This example assumes that a corrective task with ID #1 exists in the first project of a Synthesis repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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)