Repository.Task.UpdateScheduledTask: 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>
Updates the specified task in the repository. {{Template:BooleanReturn.Cmt}}


== Syntax ==
Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. 
*UpdateScheduledTask( task {{APIPrefix|As}} [[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}}
<noinclude>
== Syntax ==
''object''.'''Task.UpdateScheduledTask(''task'')'''


Parameters
where ''object'' is a variable that represents a Repository object.
:''task'': The [[cScheduledTask Class|cScheduledTask]] to update.


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
|task{{APIParam|Required}}||The [[CScheduledTask Class|cScheduledTask]] object to be updated.
|}
 
 
== Example ==
This example assumes that a scheduled task with ID#1 exists in the repository.
 
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Get scheduled task #1 from project #1.}}
   Dim Success As Boolean = False
   {{APIPrefix|Dim}} MyTask {{APIPrefix|As}} cScheduledTask
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  MyRepository.Project.SetCurrentProject(1) 
   {{APIPrefix|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)
{{APIComment|'Change the task's name to "New_Name."}}
  MyTask.Name = {{APIString|"New_Name"}}
{{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIPrefix|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)
 
'''VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{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 the list of scheduled tasks from the current project.}}
  {{APIComment|'Change the task's name to "New_Name."}}
   Dim ListOfTasks() As [[cScheduledTask Class|cScheduledTask]]
   MyTask.Name = {{APIString|"New_Name"}}
  ListOfTasks = MyRepository.Task.GetAllScheduledTasks()
 
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'After updating the task, update the repository}}
   MyRepository.Task.UpdateScheduledTask(MyTask)
   Dim Success As Boolean
</noinclude>
  Success = MyRepository.Task.UpdateScheduledTask(ListOfTasks(0))

Revision as of 22:00, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

Syntax

object.Task.UpdateScheduledTask(task)

where object is a variable that represents a Repository object.

Parameters

Name Description
taskborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cScheduledTask object to be updated.


Example

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

 'Change the task's name to "New_Name." 
 MyTask.Name = "New_Name"

 'Apply the update to the URD. Changes will be reflected in the repository. 
 Call MyRepository.Task.UpdateScheduledTask(MyTask)

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)

 'Change the task's name to "New_Name." 
 MyTask.Name = "New_Name"

 'Apply the update to the URD. Changes will be reflected in the repository. 
 MyRepository.Task.UpdateScheduledTask(MyTask)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Task.UpdateScheduledTask&oldid=59456"