Repository.Task.AddCorrectiveTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>


Saves a new [[CCorrectiveTask Class|cCorrectiveTask]] object to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates that the task now exists in the repository.   
 
Saves a new [[CCorrectiveTask Class|cCorrectiveTask]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.   
<noinclude>
<noinclude>
If a task with the same name already exists in the current project, the application will automatically increment the name. For example, if "Task1" already exists, the new task might be renamed to "Task2," "Task3," etc.
== Syntax ==
== Syntax ==
''object''.'''Task.AddCorrectiveTask(''task'')'''
'''.Task.AddCorrectiveTask'''(''task'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''task''
|-
:The [[CCorrectiveTask Class|cCorrectiveTask]] object to be added. (Required)
|task{{APIParam|Required}}||The [[CCorrectiveTask Class|cCorrectiveTask]] object to be added.
|}




== Example ==
== Example ==
This example creates a new corrective task reource, and then saves it in the first available project in a Synthesis repository.
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
Line 31: Line 31:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
  {{APIComment|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}

Revision as of 18:52, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Saves a new cCorrectiveTask object to the current project. Returns a Boolean value; when true, indicates a successful save.

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

Syntax

.Task.AddCorrectiveTask(task)

Parameters

task

The cCorrectiveTask object to be added. (Required)


Example

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

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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. The task will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 Call MyRepository.Task.AddCorrectiveTask(NewTask)
VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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. The task will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.Task.AddCorrectiveTask(NewTask)