Repository.Variable.GetVariable: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude> | <onlyinclude>Returns a '''[[CVariable Class|cVariable]]''' object, which represents a variable resource. Returns nothing if the variable does not exist or is not in the current project.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 17: | Line 17: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|' | {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get variable #1 from project #1.}} | {{APIComment|'Get variable #1 from project #1.}} | ||
{{APIPrefix|Dim}} AVariable {{APIPrefix|As}} cVariable | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} AVariable = MyRepository.Variable.GetVariable(1) | |||
{{APIComment|'Output sample: Display the name and ID of the variable.}} | {{APIComment|'Output sample: Display the name and ID of the variable.}} | ||
{{APIPrefix|Dim}} VariableName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} VariableID {{APIPrefix|As}} Integer | |||
VariableName = AVariable.Name | |||
VariableID = AVariable.ID | |||
MsgBox ({{APIString|"You got "}} & VariableName & {{APIString|", ID#"}} & VariableID) | |||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get variable #1 from project #1.}} | {{APIComment|'Get variable #1 from project #1.}} | ||
{{APIPrefix|Dim}} AVariable {{APIPrefix|As}} cVariable | |||
MyRepository.Project.SetCurrentProject(1) | |||
AVariable = MyRepository.Variable.GetVariable(1) | |||
{{APIComment|'Output sample: Display the name and ID of the variable.}} | {{APIComment|'Output sample: Display the name and ID of the variable.}} | ||
{{APIPrefix|Dim}} VariableName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} VariableID {{APIPrefix|As}} Integer | |||
VariableName = AVariable.Name | |||
VariableID = AVariable.ID | |||
MsgBox ({{APIString|"You got "}} & VariableName & {{APIString|", ID#"}} & VariableID) | |||
Revision as of 16:56, 8 April 2016
 |
Member of: SynthesisAPI.Repository
Returns a cVariable object, which represents a variable resource. Returns nothing if the variable does not exist or is not in the current project.
Syntax
.Variable.GetVariable(ID)
Parameters
ID
- Required. Integer. The ID number of the variable to retrieve.
Example
The example assumes that a variable with ID #1 exists in the first project of a Synthesis repository.
VBA 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") '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 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") '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)