Repository.Action.GetAction: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 6: | Line 6: | ||
== Syntax == | == Syntax == | ||
'''Action.GetAction'''(''ID'') | '''Action.GetAction'''(''ID'') | ||
=== Parameters === | === Parameters === | ||
''ID'' | ''ID'' | ||
:Integer. The ID number of the action to retrieve. | :Required. Integer. The ID number of the action to retrieve. | ||
== Example == | == Example == | ||
This example assumes that an action with ID#1 exists in a repository. | This example assumes that an action with ID #1 exists in the first project of a Synthesis repository. | ||
'''VBA''' | '''VBA''' | ||
Revision as of 23:30, 24 August 2015
Member of: SynthesisAPI10.Repository
Gets the action with the designated ID number and returns it as a cAction object. Returns nothing if the action does not exist or is not in the current project.
Syntax
Action.GetAction(ID)
Parameters
ID
- Required. Integer. The ID number of the action to retrieve.
Example
This example assumes that an action with ID #1 exists in the first project of a Synthesis 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) 'Output sample: Display the name and ID of the action. Dim ActionName As String Dim ActionID As Integer ActionName = MyAction.ActionDescription ActionID = MyAction.ID MsgBox ("ID# " & ActionID & ", " & ActionName)
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) 'Output sample: Display the name and ID of the action. Dim ActionName As String Dim ActionID As Integer ActionName = MyAction.ActionDescription ActionID = MyAction.ID MsgBox ("ID# " & ActionID & ", " & ActionName)