Repository.Action.GetAction: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Returns a cAction object that represents a given action resource in the current project. 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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:Repository.GetAction.Cmt}}
-==Syntax==
-* GetAction({{APIPrefix|As}} [[cAction Class|cAction]])
-Parameters
+<onlyinclude>Returns a '''[[CAction Class|cAction]]''' object that represents a given action resource in the current project. Returns nothing if the action does not exist or is not in the current project.</onlyinclude>
-Enter the Action ID to get desired action.
+== Syntax ==
+ '''Action.GetAction'''(''ID'')
-== Usage Example ==
+=== Parameters ===
-  {{APIComment|'Declare a new repository connection object.}}
+''ID''
-  Dim MyRepository As New Repository
+: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'''
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  {{APIComment|'Connect to the Synthesis repository.}}
+  {{APIComment|'Get action #1 from project #1.}}
-  Dim Success As Boolean = False
+   {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} MyAction = MyRepository.Action.GetAction(1)
-  {{APIComment|'Get the list of actions in the connected repository.}}
-  Dim ListOfActions() As [[cAction Class|cAction]]
+  {{APIComment|'Output sample: Display the name and ID of the action.}}
-  ListOfActions = MyRepository.GetAllActions()
+   {{APIPrefix|Dim}} ActionName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer
-  {{APIComment|'Get an Action.}}
+   ActionName = MyAction.ActionDescription
-  Dim GetAction() as cAction
+   ActionID = MyAction.ID
-  GetAction= MyRepository.GetAction(1)
+   MsgBox ({{APIString|"ID# "}} & ActionID & {{APIString|", "}} & ActionName)
+ '''VB.NET'''
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
+  {{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 & {{APIString|", "}} & ActionName)

Repository.Action.GetAction: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search