Repository.Action.GetAllActions: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(10 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 an array of '''[[CAction Class|cAction]]''' objects that represent the action resources in the current project.</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. 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Action.GetAllActions()'''
'''.Action.GetAllActions'''(''Filter'')
 
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.


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


== Example ==
== Example ==
Line 12: Line 16:


  '''VBA|VB.NET'''
  '''VBA|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 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
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  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 actions in the project.}}
  {{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)
</noinclude>

Latest revision as of 18:52, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cAction objects that represent the action resources in the current project.

Syntax

.Action.GetAllActions(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

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

VBA|VB.NET
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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 actions in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofActions) - LBound(ListofActions) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.GetAllActions&oldid=64310"