Repository.Action.GetAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<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>  


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.
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Action.GetAction(''ID'')'''
'''Action.GetAction'''(''ID'')
 
where ''object'' is a variable that represents a Repository object.


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




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


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to 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.}}
  {{APIComment|'Get action #1 from project #1.}}
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  {{APIPrefix|Dim}} MyAction {{APIPrefix|As}} cAction
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  MyAction = MyRepository.Action.GetAction(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}} ActionName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer
  ActionName = MyAction.ActionDescription
  ActionName = MyAction.ActionDescription
  ActionID = MyAction.ID
  ActionID = MyAction.ID
  MsgBox ({{APIString|"ID# "}} & ActionID & ", " & ActionName)
  MsgBox ({{APIString|"ID# "}} & ActionID & {{APIString|", "}} & ActionName)
</noinclude>

Latest revision as of 18:53, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.GetAction&oldid=64318"