Repository.Task.UpdateCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Updates the properties of a given corrective task in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>


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. 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Task.UpdateCorrectiveTask(''task'')'''
'''.Task.UpdateCorrectiveTask'''(''task'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== 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 ==
== 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'''
   
   
  {{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.}}
  {{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'''
  '''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.}}
  {{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)</noinclude>
  MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude>

Latest revision as of 17:37, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.UpdateCorrectiveTask&oldid=64272"