Repository.Task.GetScheduledTask: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>


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.  
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.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Task.GetScheduledTask(''ID'')'''
'''.Task.GetScheduledTask'''(''ID'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Integer. The ID number of the scheduled task to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the scheduled task to retrieve.
|}




Line 19: Line 15:
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
 
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
Line 36: Line 34:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
 
  {{APIComment|'Get scheduled task #1 from project #1.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask

Revision as of 20:43, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository


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

Integer. The ID number of the scheduled task to retrieve.


Example

This example assumes that a scheduled task with ID#1 exists in a 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)