Repository.Task.GetScheduledTask: Difference between revisions

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


==Syntax==
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.
*GetScheduledTask({{APIPrefix|As}}[[cScheduledTask Class|cScheduledTask]])
<noinclude>
== Syntax ==
''object''.'''Task.GetScheduledTask(''ID'')'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
{{APIComment|'Declare a new repository connection object.}}
=== Parameters ===
   Dim MyRepository As New Repository
{| {{APITable}}
 
|-
  {{APIComment|'Connect to the Synthesis repository.}}
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the scheduled task to retrieve.
   Dim Success As Boolean = False
|}
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
    
 
  {{APIComment|'Set a first available project as current.}}
== Example ==
   MyRepository.Project.SetCurrentProject(0)
This example assumes that a scheduled task with ID#1 exists in a repository.
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
{{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:}}
  {{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'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
{{APIComment|'Get scheduled task #1 from project #1.}}
  {{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:}}
   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)
</noinclude>

Revision as of 22:39, 16 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

object.Task.GetScheduledTask(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 'Get scheduled task #1 from project #1. 
 Dim MyTask As cScheduledTask
 MyRepository.Project.SetCurrentProject(1)
 Set MyTask = MyRepository.Task.GetScheduledTask(1)

 'Output sample: 
 Dim TaskName As String
 Dim TaskID As Integer
 TaskName = MyTask.Name
 TaskID = MyTask.ID
 MsgBox ("You got " & TaskName & ", ID#" & TaskID)

VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 'Get scheduled task #1 from project #1. 
 Dim MyTask As cScheduledTask
 MyRepository.Project.SetCurrentProject(1)
 MyTask = MyRepository.Task.GetScheduledTask(1)

 'Output sample: 
 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=59469"