Repository.Task.GetScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetScheduled.Cmt}}


==Syntax==
*GetScheduledTask({{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]])


== Usage Example ==
<onlyinclude>Returns a '''[[CScheduledTask Class|cScheduledTask]]''' object that represents a given scheduled task resource in the current project. Returns nothing if the task does not exist or is not in the current project.</onlyinclude>
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
'''.Task.GetScheduledTask'''(''ID'')
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
=== Parameters ===
  Dim Success As Boolean = False
''ID''
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
: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'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{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.}}
  {{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'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})  
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
  MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
  MyRepository.Project.SetCurrentProject(1)
  MyTask = MyRepository.Task.GetScheduledTask(1)
   
   
  {{APIComment|'Get Scheduled Task with the ID of 1.}}
  {{APIComment|'Output sample: Display the name and ID of the task.}}
  Dim GetScheduledTask() as cScheduledTask
  {{APIPrefix|Dim}} TaskName {{APIPrefix|As}} String
  GetScheduledTask= MyRepository.Task.GetScheduledTask(1)
  {{APIPrefix|Dim}} TaskID {{APIPrefix|As}} Integer
</div>
  TaskName = MyTask.Name
  TaskID = MyTask.ID
  MsgBox ({{APIString|"You got "}} & TaskName & {{APIString|", ID#"}} & TaskID)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cScheduledTask object that represents a given scheduled task resource in the current project. 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.GetScheduledTask&oldid=64326"