Difference between revisions of "Repository.Variable.AddVariable"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
<onlyinclude>Saves a new [[CVariable Class|cVariable]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
+
<onlyinclude>Adds a new variable resource to a Synthesis repository. 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 current project, the application will automatically increment the name. For example, if "Var1" already exists, the new variable might be renamed to "Var2," "Var3," etc.
 
 
== Syntax ==
 
== Syntax ==
 
  '''.Variable.AddVariable'''(''var'')
 
  '''.Variable.AddVariable'''(''var'')
Line 10: Line 11:
 
=== Parameters ===
 
=== Parameters ===
 
''var''
 
''var''
:The [[CVariable Class|cVariable]] object to be added. (Required)
+
:Required. The [[CVariable Class|cVariable]] object to be added. (Required)
  
  
Line 26: Line 27:
 
   NewVariable.Name = {{APIString|"MyNewVariable"}}
 
   NewVariable.Name = {{APIString|"MyNewVariable"}}
 
   
 
   
  {{APIComment|'Add the new variable to project #1. The variable will be visible in the Synthesis repository upon refresh.}}
+
  {{APIComment|'Add the new variable to project #1.}}
 
   MyRepository.Project.SetCurrentProject(1)   
 
   MyRepository.Project.SetCurrentProject(1)   
 
   {{APIPrefix|Call}} MyRepository.Variable.AddVariable(NewVariable)
 
   {{APIPrefix|Call}} MyRepository.Variable.AddVariable(NewVariable)
Line 40: Line 41:
 
   {{APIPrefix|Dim}} newVariable {{APIPrefix|As New}} cVariable ({{APIString|"MyNewVariable"}})
 
   {{APIPrefix|Dim}} newVariable {{APIPrefix|As New}} cVariable ({{APIString|"MyNewVariable"}})
 
   
 
   
  {{APIComment|'Add the new variable to project #1. The variable will be visible in the Synthesis repository upon refresh.}}
+
  {{APIComment|'Add the new variable to project #1.}}
 
   MyRepository.Project.SetCurrentProject(1)   
 
   MyRepository.Project.SetCurrentProject(1)   
 
   MyRepository.Variable.AddVariable(newVariable)
 
   MyRepository.Variable.AddVariable(newVariable)

Revision as of 21:41, 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. (Required)


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)