Repository.Task.GetCorrectiveTask: Difference between revisions

Latest revision as of 18:55, 9 June 2016

Returns a cCorrectiveTask object that represents a given corrective task resource in the current project. 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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:Repository.GetCorrectiveTask.Cmt}}
-==Syntax==
-*GetCorrectiveTask({{APIPrefix|As}}[[cCorrectiveTask Class|cCorrectiveTask]])
-== Usage Example ==
+<onlyinclude>Returns a '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object that represents a given corrective task resource in the current project. Returns nothing if the task does not exist or is not in the current project.</onlyinclude>
-<div style="margin-right: 150px;">
-  {{APIComment|'Declare a new repository connection object.}}
+== Syntax ==
-  Dim MyRepository As New Repository
+ '''.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'''
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  {{APIComment|'Connect to the Synthesis repository.}}
+  {{APIComment|'Get corrective task #1 from project #1.}}
-  Dim Success As Boolean = False
+   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} MyTask = MyRepository.Task.GetCorrectiveTask(1)
-  {{APIComment|'Set a first available project as current.}}
-  MyRepository.Project.SetCurrentProject(0)
+ {{APIComment|'Output sample: Display the name and ID of the task.}}
+   {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
+   TaskName = MyTask.Name
+   TaskID = MyTask.ID
+   MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)
+ '''VB.NET'''
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
+  {{APIComment|'Get corrective task #1 from project #1.}}
+   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cCorrectiveTask
+   MyRepository.Project.SetCurrentProject(1)
+   MyTask = MyRepository.Task.GetCorrectiveTask(1)
-  {{APIComment|'Get Corrective Task with the ID of 1.}}
+  {{APIComment|'Output sample: Display the name and ID of the task.}}
-  Dim GetCorrectiveTask() as cCorrectiveTask
+   {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
-  GetCorrectiveTask= MyRepository.Task.GetCorrectiveTask(1)
+   {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
-</div>
+   TaskName = MyTask.Name
+   TaskID = MyTask.ID
+   MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)

Repository.Task.GetCorrectiveTask: Difference between revisions

Latest revision as of 18:55, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search