Repository.Variable.AddVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 11: Line 11:
=== Parameters ===
=== Parameters ===
''var''
''var''
:Required. The [[CVariable Class|cVariable]] object to be added. (Required)
:Required. The [[CVariable Class|cVariable]] object to be added.





Revision as of 21:49, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Adds a new variable resource to a Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

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.

Syntax

.Variable.AddVariable(var)

Parameters

var

Required. The cVariable object 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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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)