Repository.Task.UpdateScheduledTask: 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>


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.   
Updates the properties of an existing scheduled task in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.   
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Task.UpdateScheduledTask(''task'')'''
'''.Task.UpdateScheduledTask'''(''task'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''task''
|-
:The [[CScheduledTask Class|cScheduledTask]] object to be updated.
|task{{APIParam|Required}}||The [[CScheduledTask Class|cScheduledTask]] object to be updated.
|}




Line 20: 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 33:
  '''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.}}

Revision as of 20:29, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository

Updates the properties of an existing scheduled task in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Task.UpdateScheduledTask(task)

Parameters

task

The cScheduledTask object to be updated.


Example

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

 '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

 '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)

 '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=59590"