Repository.Task.UpdateCorrectiveTask: Difference between revisions

Latest revision as of 17:37, 9 June 2016

Updates the properties of a given corrective task in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Task.UpdateCorrectiveTask(task)

Parameters

task

Required. The cCorrectiveTask object that represents the corrective task to be updated.

Example

This example assumes that a corrective task with ID #1 exists in the first available project of a 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)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Task.UpdateCorrectiveTask(MyTask)

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)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Task.UpdateCorrectiveTask(MyTask)

@@ Line 1: / Line 1: @@
-{{Template:APIBreadcrumb|10|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:API}}
-Saves all updates to a corrective task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
+<onlyinclude>Updates the properties of a given corrective task in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
 == Syntax ==
-''object''.'''Task.UpdateCorrectiveTask(''task'')'''
+ '''.Task.UpdateCorrectiveTask'''(''task'')
-where ''object'' is a variable that represents a Repository object.
 === Parameters ===
-{| {{APITable}}
+''task''
-|-
+:Required. The [[CCorrectiveTask Class|cCorrectiveTask]] object that represents the corrective task to be updated.
-|task{{APIParam|Required}}||The '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object to be updated.
-|}
 == Example ==
-This example assumes that a corrective task with ID#1 exists in the repository.
+This example assumes that a corrective task with ID #1 exists in the first available project of a repository.
   '''VBA'''
-  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
- {{APIComment|...'Add code to 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
+   {{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|'Change the task's name to "New_Name".}}
+  {{APIComment|'Change the task's name to "New_Name."}}
-  MyTask.Name = "New_Name"
+   MyTask.Name = {{APIString|"New_Name"}}
-  {{APIComment|'Apply the update to the task. Changes will be reflected in the repository.}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
-  {{APIPrefix|Call}} MyRepository.Task.UpdateCorrectiveTask(MyTask)
+   {{APIPrefix|Call}} MyRepository.Task.UpdateCorrectiveTask(MyTask)
   '''VB.NET'''
-  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
- {{APIComment|...'Add code to 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
+   {{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|'Change the task's name to "New_Name".}}
+  {{APIComment|'Change the task's name to "New_Name."}}
-  MyTask.Name = "New_Name"
+   MyTask.Name = {{APIString|"New_Name"}}
-  {{APIComment|'Apply the update to the task. Changes will be reflected in the repository.}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
-  MyRepository.Task.UpdateCorrectiveTask(MyTask)
+   MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>

Repository.Task.UpdateCorrectiveTask: Difference between revisions

Latest revision as of 17:37, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search