Repository.Action.UpdateAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|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.   
<onlyinclude>Updates the properties of a given action resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>  
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Action.UpdateAction'''(''action'')
  '''.Action.UpdateAction'''(''action'')
=== Parameters ===
=== Parameters ===
''action''
''action''
:The [[CAction Class|cAction]] object to be updated.
:Required. The [[CAction Class|cAction]] object that represents the action resource 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'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get action #1 from project #1.}}
  {{APIComment|'Get action #1 from project #1.}}
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1)
  {{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1)
   
   
  {{APIComment|'Change the action's name to "New_Name."}}
  {{APIComment|'Change the action's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)
  {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get action #1 from project #1.}}
  {{APIComment|'Get action #1 from project #1.}}
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyAction = MyRepository.Action.GetAction(1)
  MyAction = MyRepository.Action.GetAction(1)
   
   
  {{APIComment|'Change the action's name to "New_Name."}}
  {{APIComment|'Change the action's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
   MyRepository.Action.UpdateAction(MyAction)
   MyRepository.Action.UpdateAction(MyAction)
</noinclude>

Latest revision as of 15:40, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given action resource in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Action.UpdateAction(action)

Parameters

action

Required. The cAction object that represents the action resource to be updated.


Example

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

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Action.UpdateAction(MyAction)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
 MyRepository.Action.UpdateAction(MyAction)