Repository.Action.UpdateAction: 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 an action. 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 action 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''.'''Action.UpdateAction(''action'')'''
'''.Action.UpdateAction'''(''action'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''action''
|-
:The [[CAction Class|cAction]] object to be updated.
|action{{APIParam|Required}}||The [[CAction Class|cAction]] 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 action #1 from project #1.}}
  {{APIComment|'Get action #1 from project #1.}}
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 action #1 from project #1.}}
  {{APIComment|'Get action #1 from project #1.}}

Revision as of 20:31, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository

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

Syntax

.Action.UpdateAction(action)

Parameters

action

The cAction object to be updated.


Example

This example assumes that an action with ID#1 exists in the repository.

VBA

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

 
 'Get action #1 from project #1. 
 Dim MyAction As cAction
 MyRepository.Project.SetCurrentProject(1)  
 Set MyAction = MyRepository.Action.GetAction(1)

 'Change the action's name to "New_Name." 
 MyAction.Name = "New_Name"

 'Apply the update to the action. Changes will be reflected in the repository. 
 Call MyRepository.Action.UpdateAction(MyAction)
VB.NET

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

 
 'Get action #1 from project #1. 
 Dim MyAction As cAction
 MyRepository.Project.SetCurrentProject(1)  
 MyAction = MyRepository.Action.GetAction(1)

 'Change the action's name to "New_Name." 
 MyAction.Name = "New_Name"

 'Apply the update to the action. Changes will be reflected in the repository. 
 MyRepository.Action.UpdateAction(MyAction)