Repository.Task.UpdateCorrectiveTask: Difference between revisions

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




<onlyinclude>Updates the properties of an existing corrective task in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>   
<onlyinclude>Applies any changes made to an existing corrective task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   


== Syntax ==
== Syntax ==
  '''.Task.UpdateCorrectiveTask'''(''task'')
  '''.Task.UpdateCorrectiveTask'''(''task'')
=== Parameters ===
=== Parameters ===
''task''
''task''
:The [[CCorrectiveTask Class|cCorrectiveTask]] object to be updated.
:Required. The [[CCorrectiveTask Class|cCorrectiveTask]] object to be updated.




== Example ==
== 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'''
  '''VBA'''
Line 29: Line 30:
   MyTask.Name = {{APIString|"New_Name"}}
   MyTask.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the task. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Task.UpdateCorrectiveTask(MyTask)
   {{APIPrefix|Call}} MyRepository.Task.UpdateCorrectiveTask(MyTask)


Line 47: Line 48:
   MyTask.Name = {{APIString|"New_Name"}}
   MyTask.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the task. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
   MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>
   MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>

Revision as of 20:57, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing corrective task. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Task.UpdateCorrectiveTask(task)

Parameters

task

Required. The cCorrectiveTask object to be updated.


Example

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

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

 'Apply the change to the task. Changes are recorded in the Synthesis repository. 
 Call MyRepository.Task.UpdateCorrectiveTask(MyTask)
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)

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

 'Apply the change to the task. Changes are recorded in the Synthesis repository. 
 MyRepository.Task.UpdateCorrectiveTask(MyTask)