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: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | ||
Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. | Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. |
Revision as of 17:29, 17 July 2015
Member of: SynthesisAPI10Repository
Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Syntax
object.Task.UpdateScheduledTask(task)
where object is a variable that represents a Repository object.
Parameters
Name | Description | |
---|---|---|
taskborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder" | ||
Name | Status | The cScheduledTask object to be updated. |
Example
This example assumes that a scheduled task with ID#1 exists in the repository.
VBA Dim MyRepository As New Repository ...'Add code to connect to a Synthesis 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 Dim MyRepository As New Repository ...'Add code to connect to a Synthesis 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)