Repository.Action.GetAllActions: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>   
<onlyinclude>Gets a list of actions associated with a project. Returns a '''[[CAction Class|cAction]]''' object array that contains all the actions in that project.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofActions = MyRepository.Action.GetAllActions()
   ListofActions = MyRepository.Action.GetAllActions()
   
   
  {{APIComment|'Output sample: Display the description and ID# of the first available action in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} ActionName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} ActionID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofActions) - LBound(ListofActions) + 1
   ActionName = ListofActions(0).ActionDescription
   MsgBox (NumberofElements)
  ActionID = ListofActions(0).ID
   MsgBox (ActionName & ActionID)

Revision as of 22:58, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of actions associated with a project. Returns a cAction object array that contains all the actions in that project.

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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofActions) - LBound(ListofActions) + 1
 MsgBox (NumberofElements)