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 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | |||
<onlyinclude>Updates the properties of an existing scheduled task in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> | |||
== Syntax == | == Syntax == | ||
'''.Task.UpdateScheduledTask'''(''task'') | '''.Task.UpdateScheduledTask'''(''task'') | ||
| Line 48: | Line 49: | ||
{{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}} | {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}} | ||
MyRepository.Task.UpdateScheduledTask(MyTask) | MyRepository.Task.UpdateScheduledTask(MyTask) | ||
Revision as of 20:24, 21 July 2015
 |
Member of: SynthesisAPI10.Repository
Updates the properties of an existing scheduled task in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Syntax
.Task.UpdateScheduledTask(task)
Parameters
task
- The cScheduledTask object to be updated.
Example
This example assumes that a scheduled task with ID#1 exists in the 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 update to the URD. Changes will be reflected in the 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 update to the URD. Changes will be reflected in the repository. MyRepository.Task.UpdateScheduledTask(MyTask)