Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Gets an array containing all Variables
== Method Syntax==


{{APIName|'''GetAllVariables'''()}}
{{APIPrefix|As}}
{{APIName|[[cVariable Class|cVariable]]()}}
{{APIPrefix|As Boolean}}<br>
{{APIComment|Returns an array containing all Variables from the current project.}}


== Usage Example ==
<onlyinclude>Returns an array of '''[[CVariable_Class|cVariable]]''' objects that represent the variable resources in the current project.</onlyinclude> 
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
== Syntax ==
        Dim Success As Boolean = False
'''.Variable.GetAllVariables'''(''Filter'')
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get the list of Variables in the connected repository.}}
===Parameters===
        Dim ListOfVariables() As [[cVariable Class|cVariable]]
''Filter''
        ListOfVariables = MyRepository.GetAllVariables()
: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.
 
 
== Example ==
This example assumes that variables exist in the first available project of a repository.
 
'''VBA|VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get a list of all local variables in project #1.}}
  {{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable
  MyRepository.Project.SetCurrentProject (1) 
  ListofVariables = MyRepository.Variable.GetAllVariables()
{{APIComment|'Output sample: Display the number of variables in the project.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
  MsgBox (NumberofElements)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cVariable objects that represent the variable resources in the current 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

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

 'Output sample: Display the number of variables in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Variable.GetAllVariables&oldid=64330"