Repository.Action.GetAllActions: 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 Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
 


Gets a list of all existing actions in the current project. Returns a '''[[CAction Class|cAction]]''' object array that contains the action names, ID numbers and other information.   
Gets a list of all existing actions in the current project. Returns a '''[[CAction Class|cAction]]''' object array that contains the action names, ID numbers and other information.   
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Action.GetAllActions()'''
'''.Action.GetAllActions()'''


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


== Example ==
== Example ==
Line 13: Line 13:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
 
  {{APIComment|'Get a list of all actions in project #1.}}
  {{APIComment|'Get a list of all actions in project #1.}}
   {{APIPrefix|Dim}} ListofActions() {{APIPrefix|As}} cAction
   {{APIPrefix|Dim}} ListofActions() {{APIPrefix|As}} cAction

Revision as of 18:17, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all existing actions in the current project. Returns a cAction object array that contains the action names, ID numbers and other information.

Syntax

.Action.GetAllActions()


Example

This example assumes that actions exist in the first available project of a repository.

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 'Get a list of all actions in project #1. 
 Dim ListofActions() As cAction
 MyRepository.Project.SetCurrentProject (1)  
 ListofActions = MyRepository.Action.GetAllActions()

 'Output sample: Display the description and ID# of the first available action in the project. 
 Dim ActionName As String
 Dim ActionID As Integer
 ActionName = ListofActions(0).ActionDescription
 ActionID = ListofActions(0).ID
 MsgBox (ActionName & ActionID)