Repository.Task.UpdateScheduledTask: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude> | <onlyinclude>Sends any changes made to an existing scheduled task to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 17: | Line 17: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|' | {{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 | ||
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 | |||
MyRepository.Project.SetCurrentProject(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"}} | |||
{{APIComment|' | {{APIComment|'Send the change to the Synthesis repository.}} | ||
{{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask) | |||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{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 | ||
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 | |||
MyRepository.Project.SetCurrentProject(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"}} | |||
{{APIComment|' | {{APIComment|'Send the change to the Synthesis repository.}} | ||
MyRepository.Task.UpdateScheduledTask(MyTask) | |||
Revision as of 18:43, 8 April 2016
 |
Member of: SynthesisAPI.Repository
Sends any changes made to an existing scheduled task to the Synthesis repository. 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 '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)