Repository.Task.AddCorrectiveTask: Difference between revisions

Latest revision as of 20:36, 18 August 2016

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-Adds a corrective task
-== Method Syntax==
-{{APIName|'''AddCorrectiveTask'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|task()}}
-{{APIPrefix|As}}
-{{APIName|[[cCorrectiveTask Class|cCorrectiveTask]]}}
-{{APIPrefix|) As Boolean}}<br>
-{{APIComment|Saves the corrective task in the repository.}}
-== Parameters ==
-'''task'''
-{{APIComment|The new corrective task to add to the repository.}}
-== 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 class.}}
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
-        Dim Success As Boolean = False
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Declare a new cCorrectiveTask.}}
+'''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.
-        Dim newCorrectiveTask As New cCorrectiveTask("NewCorrectiveTask1")
-{{APIComment|After creating the task, update the repository}}
+== Syntax ==
-        Dim SuccessAddCorrectiveTask As Boolean = False
+ '''.Task.AddCorrectiveTask'''(''task'')
-        SuccessAddCorrectiveTask = MyRepository.AddCorrectiveTask(newCorrectiveTask)
+=== 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|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
+   {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cCorrectiveTask
+   NewTask.Name = {{APIString|"MyNewTask"}}
+ {{APIComment|'Add the new task to project #1.}}
+   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|'Create a new corrective task. The following example creates a corrective task named "MyNewTask."}}
+   {{APIPrefix|Dim}} NewTask {{APIPrefix|As New}} cCorrectiveTask ({{APIString|"MyNewTask"}})
+ {{APIComment|'Add the new task to project #1.}}
+   MyRepository.Project.SetCurrentProject(1)
+   MyRepository.Task.AddCorrectiveTask(NewTask)

Repository.Task.AddCorrectiveTask: Difference between revisions

Latest revision as of 20:36, 18 August 2016

Syntax

Parameters

Example

Navigation menu

Search