Repository.Action.GetAllActions: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:




<onlyinclude>Gets a list of actions associated with a project. Returns a '''[[CAction Class|cAction]]''' object that represents the action resources.</onlyinclude>   
<onlyinclude>Returns an array of '''[[CAction Class|cAction]]''' objects that represent the action resources in the current project.</onlyinclude>   


== Syntax ==
== Syntax ==
  '''.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.





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)