Repository.Task.GetScheduledTask: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
<onlyinclude>Gets the scheduled task with the designated ID number and returns it as a '''[[CScheduledTask Class|cScheduledTask]]''' object. Returns nothing if the task does not exist or is not in the current project.</onlyinclude> | <onlyinclude>Gets the scheduled task with the designated ID number and returns it as a '''[[CScheduledTask Class|cScheduledTask]]''' object. Returns nothing if the task does not exist or is not in the current project.</onlyinclude> | ||
Revision as of 22:20, 13 November 2015
 |
Member of: SynthesisAPI.Repository
Gets the scheduled task with the designated ID number and returns it as a cScheduledTask object. Returns nothing if the task does not exist or is not in the current project.
Syntax
.Task.GetScheduledTask(ID)
Parameters
ID
- Required. Integer. The ID number of the scheduled task to retrieve.
Example
This example assumes that a scheduled task with ID #1 exists in the first project of a Synthesis 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) 'Output sample: Display the name and ID of the task. Dim TaskName As String Dim TaskID As Integer TaskName = MyTask.Name TaskID = MyTask.ID MsgBox ("You got " & TaskName & ", ID#" & TaskID)
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) 'Output sample: Display the name and ID of the task. Dim TaskName As String Dim TaskID As Integer TaskName = MyTask.Name TaskID = MyTask.ID MsgBox ("You got " & TaskName & ", ID#" & TaskID)