Repository.Task.UpdateScheduledTask: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude> | <onlyinclude>Applies any changes made to an existing scheduled task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
'''.Task.UpdateScheduledTask'''(''task'') | '''.Task.UpdateScheduledTask'''(''task'') | ||
=== Parameters === | === Parameters === | ||
''task'' | ''task'' | ||
:The [[CScheduledTask Class|cScheduledTask]] object to be updated. | :Required. The [[CScheduledTask Class|cScheduledTask]] object to be updated. | ||
== Example == | == Example == | ||
This example assumes that a scheduled task with ID#1 exists in the repository. | This example assumes that a scheduled task with ID #1 exists in the first available of a repository. | ||
'''VBA''' | '''VBA''' | ||
| Line 29: | Line 30: | ||
MyTask.Name = {{APIString|"New_Name"}} | MyTask.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the | {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}} | ||
{{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask) | {{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask) | ||
| Line 47: | Line 48: | ||
MyTask.Name = {{APIString|"New_Name"}} | MyTask.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the | {{APIComment|'Apply the change to the task. Changes are recorded in the Synthesis repository.}} | ||
MyRepository.Task.UpdateScheduledTask(MyTask) | MyRepository.Task.UpdateScheduledTask(MyTask) | ||
Revision as of 21:00, 24 August 2015
 |
Member of: SynthesisAPI10.Repository
Applies any changes made to an existing scheduled task. Returns a Boolean value; when true, indicates a successful save.
Syntax
.Task.UpdateScheduledTask(task)
Parameters
task
- Required. The cScheduledTask object to be updated.
Example
This example assumes that a scheduled task with ID #1 exists in the first available of a repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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" 'Apply the change to the task. Changes are recorded in the Synthesis repository. Call MyRepository.Task.UpdateScheduledTask(MyTask)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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" 'Apply the change to the task. Changes are recorded in the Synthesis repository. MyRepository.Task.UpdateScheduledTask(MyTask)