Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}
 
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.   
 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Variable.GetAllVariables()'''
''object''.'''Variable.GetAllVariables()'''


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


== Example ==
== Example ==
Line 28: Line 27:
   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 22:22, 16 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)