Repository.Variable.GetVariable: 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: | ||
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | |||
Gets the variable with the designated ID number and returns it as a '''[[CVariable Class|cVariable]]''' object. Returns nothing if the variable does not exist or is not in the current project. | <onlyinclude>Gets the variable with the designated ID number and returns it as a '''[[CVariable Class|cVariable]]''' object. Returns nothing if the variable does not exist or is not in the current project.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
'''.Variable.GetVariable'''(''ID'') | '''.Variable.GetVariable'''(''ID'') | ||
| Line 51: | Line 51: | ||
VariableID = AVariable.ID | VariableID = AVariable.ID | ||
MsgBox ({{APIString|"You got "}} & VariableName & {{APIString|", ID#"}} & VariableID) | MsgBox ({{APIString|"You got "}} & VariableName & {{APIString|", ID#"}} & VariableID) | ||
Revision as of 20:17, 21 July 2015
 |
Member of: SynthesisAPI10.Repository
Gets the variable with the designated ID number and returns it as a cVariable object. Returns nothing if the variable does not exist or is not in the current project.
Syntax
.Variable.GetVariable(ID)
Parameters
ID
- Integer. The ID number of the variable to retrieve.
Example
The example assumes that a variable with ID# 1 exists in the repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get variable #1 from project #1. Dim AVariable As cVariable MyRepository.Project.SetCurrentProject(1) Set AVariable = MyRepository.Variable.GetVariable(1) 'Output sample: Display the name and ID of the variable. Dim VariableName As String Dim VariableID As Integer VariableName = AVariable.Name VariableID = AVariable.ID MsgBox ("You got " & VariableName & ", ID#" & VariableID)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get variable #1 from project #1. Dim AVariable As cVariable MyRepository.Project.SetCurrentProject(1) AVariable = MyRepository.Variable.GetVariable(1) 'Output sample: Display the name and ID of the variable. Dim VariableName As String Dim VariableID As Integer VariableName = AVariable.Name VariableID = AVariable.ID MsgBox ("You got " & VariableName & ", ID#" & VariableID)