Repository.Action.UpdateAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Updates the Action
== Method Syntax==
{{APIName|'''UpdateAction'''(}}
{{APIPrefix|ByVal}}
{{APIName|var}}
{{APIPrefix|As}}
{{APIName|[[cAction Class|cAction]])}}
{{APIPrefix|As Boolean}}<br>
{{APIComment|Updates the Action in the repository.}}


== Parameters ==
'''var'''
{{APIComment|The updated Action.}}


== Usage Example ==
<onlyinclude>Updates the properties of a given action resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> 
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
== Syntax ==
        Dim Success As Boolean = False
'''.Action.UpdateAction'''(''action'')
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get the list of Projects in the connected repository.}}
=== Parameters ===
        Dim ListOfActions() As [[cAction Class|cAction]]
''action''
        ListOfActions= MyRepository.GetAllActions()
:Required. The [[CAction Class|cAction]] object that represents the action resource to be updated.


{{APIComment|Update the Action and update the repository.}}
 
        Dim SuccessUpdateAction As Boolean
== Example ==
        SuccessUpdateAction = MyRepository.UpdateAction(ListOfActions(0))
This example assumes that an action with ID #1 exists in the first available project of a repository.
 
'''VBA'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get action #1 from project #1.}}
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  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|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Action.UpdateAction(MyAction)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get action #1 from project #1.}}
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  MyRepository.Project.SetCurrentProject(1) 
  MyAction = MyRepository.Action.GetAction(1)
{{APIComment|'Change the action's name to "New_Name."}}
  MyAction.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Action.UpdateAction(MyAction)

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)