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 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude> | ||
Gets the action with the designated ID number and returns it as a '''[[CAction Class|cAction]]''' object. Returns nothing if the action does not exist or is not in the current project. | Gets the action with the designated ID number and returns it as a '''[[CAction Class|cAction]]''' object. Returns nothing if the action does not exist or is not in the current project. | ||
<noinclude> | <noinclude> | ||
== Syntax == | == Syntax == | ||
' | '''Action.GetAction'''(''ID'') | ||
=== Parameters === | === Parameters === | ||
''ID'' | |||
:Integer. The ID number of the action to retrieve. | |||
| Line 19: | Line 15: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get action #1 from project #1.}} | {{APIComment|'Get action #1 from project #1.}} | ||
| Line 36: | Line 34: | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get action #1 from project #1.}} | {{APIComment|'Get action #1 from project #1.}} | ||
Revision as of 20:49, 20 July 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
- Integer. The ID number of the action to retrieve.
Example
This example assumes that an action with ID#1 exists in 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) '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)