Repository.Action.GetAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.GetAction.Cmt}}


==Syntax==
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.
* GetAction(ByVal ID {{APIPrefix|As}} [[cAction Class|cAction]])
<noinclude>
== Syntax ==
''object''.'''Action.GetAction(''ID'')'''


Parameters
where ''object'' is a variable that represents a Repository object.


Enter the Action ID to get desired action.
=== Parameters ===
{| {{APITable}}
|-
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the action to retrieve.
|}


== Usage Example ==
 
  {{APIComment|'Declare a new repository connection object.}}
== Example ==
   Dim MyRepository As New Repository
This example assumes that an action with ID#1 exists in a repository.
    
'''VBA'''
  {{APIComment|'Connect to the Synthesis repository.}}
   Dim Success As Boolean = False
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
    
  {{APIComment|'Set a first available project as current.}}
{{APIComment|'Get action #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
   {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
 
  MyRepository.Project.SetCurrentProject(1)
  {{APIComment|'Get an Action with the ID of 1.}}
   {{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1)
   Dim GetAction() as cAction
   GetAction= MyRepository.Action.GetAction(1)
  {{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 & ", " & ActionName)
 
'''VB.NET'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
{{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.}}
   {{APIPrefix|Dim}} ActionName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer
   ActionName = MyAction.ActionDescription
  ActionID = MyAction.ID
  MsgBox ({{APIString|"ID# "}} & ActionID & ", " & ActionName)
</noinclude>

Revision as of 23:09, 16 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.GetAction&oldid=59478"