Repository.Variable.GetAllVariables: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>   
<onlyinclude>Gets a list of variables associated with a project. Returns a '''[[CVariable_Class|cVariable]]''' object array that contains all the variables in that project.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofVariables = MyRepository.Variable.GetAllVariables()
   ListofVariables = MyRepository.Variable.GetAllVariables()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available variable in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} VariableName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} VariableID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
   VariableName = ListofVariables(0).Name
   MsgBox (NumberofElements)
  VariableID = ListofVariables(0).ID
   MsgBox ({{APIString|"The first variable is: "}} & VariableName & {{APIString|", ID#"}} & VariableID)

Revision as of 22:42, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of variables associated with a project. Returns a cVariable object array that contains all the variables in that project.

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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofVariables) - LBound(ListofVariables) + 1
 MsgBox (NumberofElements)