Repository.Variable.GetAllVariables: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|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. | ||
<noinclude> | <noinclude> | ||
== Syntax == | == Syntax == | ||
' | '''.Variable.GetAllVariables()''' | ||
== Example == | == Example == | ||
| Line 13: | Line 13: | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get a list of all variables in project #1.}} | {{APIComment|'Get a list of all variables in project #1.}} | ||
{{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable | {{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable | ||
Revision as of 18:14, 20 July 2015
 |
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)