Difference between revisions of "Repository.Variable.AddVariable"

From ReliaWiki
Jump to navigation Jump to search
m
Line 2: Line 2:
  
  
<onlyinclude>Adds a new variable resource to a project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
+
<onlyinclude>Adds a new variable resource to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
  
If a variable with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Var1" already exists, the new variable might be renamed to "Var2," "Var3," etc.  
+
If a variable with the same name already exists in the project, the name will be incremented automatically. For example, if "Var1" already exists, the new variable might be renamed to "Var2," "Var3," etc.  
  
 
== Syntax ==
 
== Syntax ==
Line 11: Line 11:
 
=== Parameters ===
 
=== Parameters ===
 
''var''
 
''var''
:Required. The [[CVariable Class|cVariable]] object to be added.
+
:Required. The [[CVariable Class|cVariable]] object that represents the variable resource to be added.
  
  

Revision as of 17:40, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new variable resource to the current project. Returns a Boolean value; when true, indicates a successful save.

If a variable with the same name already exists in the project, the name will be incremented automatically. For example, if "Var1" already exists, the new variable might be renamed to "Var2," "Var3," etc.

Syntax

.Variable.AddVariable(var)

Parameters

var

Required. The cVariable object that represents the variable resource to be added.


Example

This example creates a new variable resource, and then saves it in the first available project in 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")

  'Create a new variable. The following example creates a variable named "MyNewVariable." 
  Dim newVariable As New cVariable
  NewVariable.Name = "MyNewVariable"

 'Add the new variable to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  Call MyRepository.Variable.AddVariable(NewVariable)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new variable. The following example creates a variable named "MyNewVariable." 
  Dim newVariable As New cVariable ("MyNewVariable")

 'Add the new variable to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Variable.AddVariable(newVariable)