Repository.Task.GetScheduledTask: 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>Returns a '''[[CScheduledTask Class|cScheduledTask]]''' object, which represents a scheduled task resource. Returns nothing if the task does not exist or is not in the current project.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 16: | Line 16: | ||
'''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|'Output sample: Display the name and ID of the task.}} | {{APIComment|'Output sample: Display the name and ID of the task.}} | ||
{{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer | |||
TaskName = MyTask.Name | |||
TaskID = MyTask.ID | |||
MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID) | |||
'''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|'Output sample: Display the name and ID of the task.}} | {{APIComment|'Output sample: Display the name and ID of the task.}} | ||
{{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer | |||
TaskName = MyTask.Name | |||
TaskID = MyTask.ID | |||
MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID) | |||
Revision as of 16:54, 8 April 2016
 |
Member of: SynthesisAPI.Repository
Returns a cScheduledTask object, which represents a scheduled task resource. 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 '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) '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 '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) '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)