Repository.Variable.GetAllVariables

From ReliaWiki
Revision as of 00:18, 1 March 2016 by Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI.Repository


Gets a list of variables associated with a project. Returns a cVariable object array that contains the variables in that project.

Syntax

.Variable.GetAllVariables(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 variables 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 local variables in project #1. 
 Dim ListofVariables() As cVariable
 MyRepository.Project.SetCurrentProject (1)  
 ListofVariables = MyRepository.Variable.GetAllVariables()

 'Output sample: Display the number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
 MsgBox (NumberofElements)