Repository.Action.UpdateAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>   
<onlyinclude>Applies any changes made to an existing action. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 9: Line 9:
=== Parameters ===
=== Parameters ===
''action''
''action''
:The [[CAction Class|cAction]] object to be updated.
:Required. The [[CAction Class|cAction]] object to be updated.




== Example ==
== Example ==
This example assumes that an action with ID#1 exists in the repository.
This example assumes that an action with ID #1 exists in the first available project of a repository.


  '''VBA'''
  '''VBA'''
Line 30: Line 30:
   MyAction.Name = {{APIString|"New_Name"}}
   MyAction.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the action. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the action. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)
   {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)


Line 48: Line 48:
   MyAction.Name = {{APIString|"New_Name"}}
   MyAction.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the action. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the action. Changes are recorded in the Synthesis repository.}}
   MyRepository.Action.UpdateAction(MyAction)
   MyRepository.Action.UpdateAction(MyAction)

Revision as of 21:05, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing action. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Action.UpdateAction(action)

Parameters

action

Required. The cAction object to be updated.


Example

This example assumes that an action with ID #1 exists in the first available project of a 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 change to the action. Changes are recorded in the Synthesis 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 change to the action. Changes are recorded in the Synthesis repository. 
 MyRepository.Action.UpdateAction(MyAction)