Repository.Action.GetAction

From ReliaWiki
Revision as of 16:44, 8 April 2016 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


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)