Repository.Action.GetAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|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.  

Revision as of 17:28, 17 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

object.Action.GetAction(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status Integer. The ID number of the action to retrieve.


Example

This example assumes that an action with ID#1 exists in a 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)

 '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

 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)

 '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)