Repository.Task.AddCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.AddCorrectiveTask.Cmt}} {{Template:BooleanReturn.Cmt}}
==Syntax==
*AddCorrectiveTask( task {{APIPrefix|As}} [[cCorrectiveTask Class|cCorrectiveTask]] ){{APIPrefix| As Boolean}}


Parameters
:''task'': The [[cCorrectiveTask Class|cCorrectiveTask]] to add.


== Usage Example ==
<onlyinclude>Adds a new corrective task to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> 
  {{APIComment|'Declare a new repository connection object.}}
 
  Dim MyRepository As New Repository
 
'''Remarks''': If a task with the same name already exists in the project, the name will be be incremented automatically. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.
 
== Syntax ==
'''.Task.AddCorrectiveTask'''(''task'')
 
=== Parameters ===
''task''
:Required. The [[CCorrectiveTask Class|cCorrectiveTask]] object that represents the corrective task to be added.
 
 
== Example ==
This example creates a new corrective task resource, and then saves it in the first available project in a Synthesis 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|'Connect to the Synthesis repository.}}
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
  Dim Success As Boolean = False
  {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cCorrectiveTask
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  NewTask.Name = {{APIString|"MyNewTask"}}
 
  {{APIComment|'Declare a new cCorrectiveTask.}}
{{APIComment|'Add the new task to project #1.}}
  Dim newCorrectiveTask As New cCorrectiveTask("NewCorrectiveTask1")
  MyRepository.Project.SetCurrentProject(1)    
  {{APIPrefix|Call}} MyRepository.Task.AddCorrectiveTask(NewTask)
 
'''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|'After creating the task, update the repository}}
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
  Dim SuccessAddCorrectiveTask As Boolean = False
  {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cCorrectiveTask ({{APIString|"MyNewTask"}})
   SuccessAddCorrectiveTask = MyRepository.Task.AddCorrectiveTask(newCorrectiveTask)
{{APIComment|'Add the new task to project #1.}}
  MyRepository.Project.SetCurrentProject(1)    
  MyRepository.Task.AddCorrectiveTask(NewTask)

Latest revision as of 20:36, 18 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new corrective task to the current project. Returns a Boolean value; when true, indicates a successful save.


Remarks: If a task with the same name already exists in the project, the name will be be incremented automatically. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.

Syntax

.Task.AddCorrectiveTask(task)

Parameters

task

Required. The cCorrectiveTask object that represents the corrective task to be added.


Example

This example creates a new corrective task resource, and then saves it in the first available project in a Synthesis repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new corrective task. The following example creates a corrective task named "MyNewTask." 
  Dim NewTask As New cCorrectiveTask
  NewTask.Name = "MyNewTask"

 'Add the new task to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  Call MyRepository.Task.AddCorrectiveTask(NewTask)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new corrective task. The following example creates a corrective task named "MyNewTask." 
  Dim NewTask As New cCorrectiveTask ("MyNewTask")

 'Add the new task to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Task.AddCorrectiveTask(NewTask)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.AddCorrectiveTask&oldid=64615"