Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}




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.   
<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.</onlyinclude>  
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Variable.GetAllVariables()'''
  '''.Variable.GetAllVariables()'''
Line 29: Line 29:
   VariableID = ListofVariables(0).ID
   VariableID = ListofVariables(0).ID
   MsgBox ({{APIString|"The first variable is: "}} & VariableName & {{APIString|", ID#"}} & VariableID)
   MsgBox ({{APIString|"The first variable is: "}} & VariableName & {{APIString|", ID#"}} & VariableID)
</noinclude>

Revision as of 20:16, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all existing variables in the current project. Returns a cVariable object array that contains the variable names, ID numbers and other information.

Syntax

.Variable.GetAllVariables()


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

 'Output sample: Display the name and ID of the first available variable in the project. 
 Dim VariableName As String
 Dim VariableID As Integer
 VariableName = ListofVariables(0).Name
 VariableID = ListofVariables(0).ID
 MsgBox ("The first variable is: " & VariableName & ", ID#" & VariableID)