Repository.Task.UpdateCorrectiveTask: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (30 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template: | {{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> | ||
== Syntax == | |||
'''.Task.UpdateCorrectiveTask'''(''task'') | |||
=== Parameters === | |||
''task'' | |||
:Required. The [[CCorrectiveTask Class|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''' | |||
{{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) | |||
{{APIPrefix|Set}} MyTask = MyRepository.Task.GetCorrectiveTask(1) | |||
{{APIComment|'Change the task's name to "New_Name."}} | |||
MyTask.Name = {{APIString|"New_Name"}} | |||
{{APIComment|'Send the change to the Synthesis repository.}} | |||
{{APIPrefix|Call}} MyRepository.Task.UpdateCorrectiveTask(MyTask) | |||
'''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|'Change the task's name to "New_Name."}} | |||
MyTask.Name = {{APIString|"New_Name"}} | |||
{{APIComment|'Send the change to the Synthesis repository.}} | |||
MyRepository.Task.UpdateCorrectiveTask(MyTask)</noinclude> | |||
Latest revision as of 17:37, 9 June 2016
 |
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)