Repository.Task.UpdateScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Applies any changes made to an existing scheduled task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
<onlyinclude>Updates the properties of a given scheduled task in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 9: Line 9:
=== Parameters ===
=== Parameters ===
''task''
''task''
:Required. The [[CScheduledTask Class|cScheduledTask]] object to be updated.
:Required. The [[CScheduledTask Class|cScheduledTask]] object that represents the scheduled task to be updated.




Line 17: Line 17:
  '''VBA'''
  '''VBA'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
 
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)
  {{APIPrefix|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)
   
   
  {{APIComment|'Change the task's name to "New_Name."}}
  {{APIComment|'Change the task's name to "New_Name."}}
  MyTask.Name = {{APIString|"New_Name"}}
  MyTask.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)
  {{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyTask = MyRepository.Task.GetScheduledTask(1)
  MyTask = MyRepository.Task.GetScheduledTask(1)
   
   
  {{APIComment|'Change the task's name to "New_Name."}}
  {{APIComment|'Change the task's name to "New_Name."}}
  MyTask.Name = {{APIString|"New_Name"}}
  MyTask.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Task.UpdateScheduledTask(MyTask)
  MyRepository.Task.UpdateScheduledTask(MyTask)

Latest revision as of 17:38, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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)