Repository.Action.GetAction: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude> | <onlyinclude>Returns a '''[[CAction Class|cAction]]''' object, which represents an action resource. Returns nothing if the action does not exist or is not in the current project.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 16: | Line 16: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|' | {{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 | ||
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 | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1) | |||
{{APIComment|'Output sample: Display the name and ID of the action.}} | {{APIComment|'Output sample: Display the name and ID of the action.}} | ||
{{APIPrefix|Dim}} ActionName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer | |||
ActionName = MyAction.ActionDescription | |||
ActionID = MyAction.ID | |||
MsgBox ({{APIString|"ID# "}} & ActionID & {{APIString|", "}} & ActionName) | |||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{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 | ||
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 | |||
MyRepository.Project.SetCurrentProject(1) | |||
MyAction = MyRepository.Action.GetAction(1) | |||
{{APIComment|'Output sample: Display the name and ID of the action.}} | {{APIComment|'Output sample: Display the name and ID of the action.}} | ||
{{APIPrefix|Dim}} ActionName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer | |||
ActionName = MyAction.ActionDescription | |||
ActionID = MyAction.ID | |||
MsgBox ({{APIString|"ID# "}} & ActionID & {{APIString|", "}} & ActionName) | |||
Revision as of 16:44, 8 April 2016
 |
Member of: SynthesisAPI.Repository
Returns a cAction object, which represents an action resource. 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 '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) '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 '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) '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)