Repository.Variable.GetVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetVariable.Cmt}}


==Syntax==
* GetVariable({{APIPrefix|As}} [[cVariable Class|cVariable]])


Parameters
<onlyinclude>Returns a '''[[CVariable Class|cVariable]]''' object that represents a given variable resource in the current project. Returns nothing if the variable does not exist or is not in the current project.</onlyinclude> 


Enter the Variable ID to get desired Variable.
== Syntax ==
'''.Variable.GetVariable'''(''ID'')


== Usage Example ==
=== Parameters ===
  {{APIComment|'Declare a new repository connection object.}}
''ID''
  Dim MyRepository As New Repository
:Required. Integer. The ID number of the variable to retrieve.
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
 
  Dim Success As Boolean = False
== Example ==
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
The example assumes that a variable with ID #1 exists in the first project of a Synthesis repository.
 
 
  {{APIComment|'Get the list of variables in the connected repository.}}
'''VBA'''
  Dim ListOfVariables() As [[cVariable Class|cVariable]]
  ListOfVariables = MyRepository.Variable.GetAllVariables()
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|'Get a Variable.}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  Dim GetVariable() as cVariable
   
  GetVariable MyRepository.Variable.GetVariable(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.}}
  {{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'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
{{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.}}
  {{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)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cVariable object that represents a given variable resource in the current project. 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Variable.GetVariable&oldid=64331"