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 |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | |||
<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 == | ||
'''.Task.UpdateScheduledTask'''(''task'') | '''.Task.UpdateScheduledTask'''(''task'') | ||
=== Parameters === | === Parameters === | ||
''task'' | ''task'' | ||
:The [[CScheduledTask Class|cScheduledTask]] object to be updated. | :Required. The [[CScheduledTask Class|cScheduledTask]] object that represents the scheduled task 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''' | ||
{{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) | |||
Latest revision as of 17:38, 9 June 2016
 |
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)