Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:Repository.GetAllVariables.Cmt}}
{{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.


==Syntax==
== Syntax ==
*GetAllVariables(){{APIPrefix|As}}[[cVariable Class|cVariable]]()
''object''.'''Variable.GetAllVariables()'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
 
  Dim MyRepository As New Repository
== Example ==
 
This example assumes that variables exist in the first available project of a repository.
  {{APIComment|'Connect to the Synthesis repository.}}
 
  Dim Success As Boolean = False
'''VBA|VB.NET'''
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
   
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIComment|'Get a list of all variables in project #1.}}
  {{APIPrefix|Dim}} ListofVariables() {{APIPrefix|As}} cVariable
   MyRepository.Project.SetCurrentProject (1) 
  ListofVariables = MyRepository.Variable.GetAllVariables()
   
   
  {{APIComment|'Get the list of variables in the connected repository.}}
  {{APIComment|'Output sample: Display the name and ID of the first available variable in the project.}}
   Dim ListOfVariables() As cVariable
   {{APIPrefix|Dim}} VariableName {{APIPrefix|As}} String
   ListOfVariables = MyRepository.Variable.GetAllVariables()
  {{APIPrefix|Dim}} VariableID {{APIPrefix|As}} Integer
</div>
  VariableName = ListofVariables(0).Name
   VariableID = ListofVariables(0).ID
  MsgBox ({{APIString|"The first variable is: "}} & VariableName & {{APIString|", ID#"}} & VariableID)

Revision as of 23:08, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Variable.GetAllVariables&oldid=59405"