Repository.Task.UpdateScheduledTask: Difference between revisions

Latest revision as of 17:38, 9 June 2016

Updates the properties of a given scheduled task in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Task.UpdateScheduledTask(task)

Parameters

task

Required. The cScheduledTask object that represents the scheduled task to be updated.

Example

This example assumes that a scheduled task with ID #1 exists in the first available 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 scheduled task #1 from project #1. 
  Dim MyTask As cScheduledTask
  MyRepository.Project.SetCurrentProject(1)  
  Set MyTask = MyRepository.Task.GetScheduledTask(1)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Task.UpdateScheduledTask(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 scheduled task #1 from project #1. 
  Dim MyTask As cScheduledTask
  MyRepository.Project.SetCurrentProject(1)  
  MyTask = MyRepository.Task.GetScheduledTask(1)

 'Change the task's name to "New_Name." 
  MyTask.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Task.UpdateScheduledTask(MyTask)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-Updates the specified task in the repository. {{Template:BooleanReturn.Cmt}}
-== Syntax  ==
-*UpdateScheduledTask( task {{APIPrefix|As}} [[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}} {{APIComment|{{Template:Repository.UpdateScheduledTask.Cmt}}}}
-Parameters
+<onlyinclude>Updates the properties of a given scheduled task in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
-:''task'': The [[cScheduledTask Class|cScheduledTask]] to update.
-== Usage Example ==
+== Syntax ==
-  {{APIComment|'Declare a new repository connection object.}}
+ '''.Task.UpdateScheduledTask'''(''task'')
-  Dim MyRepository As New Repository
+=== Parameters ===
-  {{APIComment|'Connect to the Synthesis repository.}}
+''task''
-  Dim Success As Boolean = False
+:Required. The [[CScheduledTask Class|cScheduledTask]] object that represents the scheduled task to be updated.
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-  {{APIComment|'Set a first available project as current.}}
+== Example ==
-  MyRepository.Project.SetCurrentProject(0)
+This example assumes that a scheduled task with ID #1 exists in the first available 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 scheduled task #1 from project #1.}}
+   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} MyTask = MyRepository.Task.GetScheduledTask(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.UpdateScheduledTask(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 scheduled task #1 from project #1.}}
+   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
+   MyRepository.Project.SetCurrentProject(1)
+   MyTask = MyRepository.Task.GetScheduledTask(1)
+ {{APIComment|'Change the task's name to "New_Name."}}
+   MyTask.Name = {{APIString|"New_Name"}}
-  {{APIComment|'Get the list of scheduled tasks from the current project.}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
-  Dim ListOfTasks() As [[cScheduledTask Class|cScheduledTask]]
+   MyRepository.Task.UpdateScheduledTask(MyTask)
-  ListOfTasks = MyRepository.Task.GetAllScheduledTasks()
- {{APIComment|'After updating the task, update the repository}}
-  Dim Success As Boolean
-  Success = MyRepository.Task.UpdateScheduledTask(ListOfTasks(0))

Repository.Task.UpdateScheduledTask: Difference between revisions

Latest revision as of 17:38, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search