Repository.Task.UpdateCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:
{| {{APITable}}
{| {{APITable}}
|-
|-
|task{{APIParam|Required}}||The '''[[CCorrectiveTask Class|cCorrectiveTask]]''' object to be updated.
|task{{APIParam|Required}}||The [[CCorrectiveTask Class|cCorrectiveTask]] object to be updated.
|}
|}


Line 28: Line 28:
   {{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|'Apply the update to the task. Changes will be reflected in the repository.}}
Line 44: Line 44:
   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|'Apply the update to the task. Changes will be reflected in the repository.}}
   MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>
   MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>
</noinclude>

Revision as of 21:55, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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.

Syntax

object.Task.UpdateCorrectiveTask(task)

where object is a variable that represents a Repository object.

Parameters

Name Description
taskborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cCorrectiveTask object to be updated.


Example

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

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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 update to the task. Changes will be reflected in the repository. 
 Call MyRepository.Task.UpdateCorrectiveTask(MyTask)
VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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 update to the task. Changes will be reflected in the repository. 
 MyRepository.Task.UpdateCorrectiveTask(MyTask)