Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 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 '''[[CVariable_Class|cVariable]]''' objects that represent the variable resources in the current project.</onlyinclude>


Gets a list of all existing variables in the current project. Returns a '''[[CVariable_Class|cVariable]]''' object array that contains the variable names, ID numbers and other information. 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Variable.GetAllVariables()'''
'''.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 Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.


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


== Example ==
== Example ==
Line 13: Line 17:
  '''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 variables in project #1.}}
 
  {{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable
  {{APIComment|'Get a list of all local variables in project #1.}}
  MyRepository.Project.SetCurrentProject (1)   
  {{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable
  ListofVariables = MyRepository.Variable.GetAllVariables()
  MyRepository.Project.SetCurrentProject (1)   
  ListofVariables = MyRepository.Variable.GetAllVariables()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available variable in the project.}}
  {{APIComment|'Output sample: Display the number of variables in the project.}}
  {{APIPrefix|Dim}} VariableName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} VariableID {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
  VariableName = ListofVariables(0).Name
  MsgBox (NumberofElements)
  VariableID = ListofVariables(0).ID
  MsgBox ({{APIString|"The first variable is: "}} & VariableName & {{APIString|", ID#"}} & VariableID)
</noinclude>

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"