Repository.Task.UpdateCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.UpdateCorrectiveTask.Cmt}} {{Template:BooleanReturn.Cmt}}


== Syntax  ==
*UpdateCorrectiveTask( task {{APIPrefix|As}} [[cCorrectiveTask Class|cCorrectiveTask]] ){{APIPrefix|As Boolean}} {{Template:Repository.UpdateCorrectiveTask.Cmt}}
*UpdateCorrectiveTask( task {{APIPrefix|As}} [[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}} {{Template:Repository.UpdateScheduledTask.Cmt}}


Parameters
<onlyinclude>Updates the properties of a given corrective task in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> 
:''task'': The [[cCorrectiveTask Class|cCorrectiveTask]] or [[cScheduledTaskClass|cScheduledTask]] to update.


== Usage Example ==
== Syntax ==
{{APIComment|Declare a new repository connection class.}}
'''.Task.UpdateCorrectiveTask'''(''task'')
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
=== Parameters ===
        Dim Success As Boolean = False
''task''
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
:Required. The [[CCorrectiveTask Class|cCorrectiveTask]] object that represents the corrective task to be updated.


{{APIComment|Get the list of corrective tasks in the connected repository from the current project.}}
        Dim ListOfCorrectiveTasks() As [[cCorrectiveTask Class|cCorrectiveTask]]
        ListOfCorrectiveTasks = MyRepository.GetAllCorrectiveTasks()


{{APIComment|After updating the task, update the repository}}
== Example ==
        Dim SuccessUpdateCorrectiveTask As Boolean = False
This example assumes that a corrective task with ID #1 exists in the first available project of a repository.
        SuccessUpdateCorrectiveTask = MyRepository.UpdateCorrectiveTask(ListOfCorrectiveTasks(0))
 
'''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

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"