Repository.Action.UpdateAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.UpdateAction.Cmt}} {{Template:BooleanReturn.Cmt}}


==Syntax==
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. 
*UpdateAction(ByVal action {{APIPrefix|As}} [[cAction Class|cAction]] ) {{APIPrefix|As Boolean}}
<noinclude>
== Syntax ==
''object''.'''Action.UpdateAction(''action'')'''


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


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
|action{{APIParam|Required}}||The [[CAction Class|cAction]] object to be updated.
|}
 
 
== Example ==
This example assumes that an action 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 action #1 from project #1.}}
   Dim Success As Boolean = False
   {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  MyRepository.Project.SetCurrentProject(1) 
   {{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1)
{{APIComment|'Change the action's name to "New_Name."}}
  MyAction.Name = {{APIString|"New_Name"}}
{{APIComment|'Apply the update to the action. Changes will be reflected in the repository.}}
  {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)
 
'''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 action #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
   MyRepository.Project.SetCurrentProject(1) 
  MyAction = MyRepository.Action.GetAction(1)
   
   
  {{APIComment|'Get the list of actions in the current project.}}
  {{APIComment|'Change the action's name to "New_Name."}}
   Dim ListOfActions() As [[cAction Class|cAction]]
   MyAction.Name = {{APIString|"New_Name"}}
  ListOfActions= MyRepository.Action.GetAllActions()
 
  {{APIComment|'Apply the update to the action. Changes will be reflected in the repository.}}
  {{APIComment|'Update the action and update the repository.}}
   MyRepository.Action.UpdateAction(MyAction)
   Dim SuccessUpdateAction As Boolean
</noinclude>
  SuccessUpdateAction = MyRepository.Action.UpdateAction(ListOfActions(0))

Revision as of 22:15, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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.

Syntax

object.Action.UpdateAction(action)

where object is a variable that represents a Repository object.

Parameters

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


Example

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

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.UpdateAction&oldid=59459"