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}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>


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.   
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.   

Revision as of 17:21, 17 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

object.Variable.GetAllVariables()

where object is a variable that represents a Repository object.

Example

This example assumes that variables exist in the first available project of a repository.

VBA|VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)