Repository.Variable.AddVariable: Difference between revisions

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




<onlyinclude>Adds a new variable resource to a Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
<onlyinclude>Adds a new variable resource to 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 destination project, the name will be incremented automatically. For example, if "Var1" already exists, the new variable might be renamed to "Var2," "Var3," etc.  
Line 18: Line 18:
  '''VBA'''
  '''VBA'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
   
  {{APIComment|'Create a new variable. The following example creates a variable named "MyNewVariable."}}
{{APIComment|'Create a new variable. The following example creates a variable named "MyNewVariable."}}
  {{APIPrefix|Dim}} newVariable {{APIPrefix|As New}} cVariable
  {{APIPrefix|Dim}} newVariable {{APIPrefix|As New}} cVariable
  NewVariable.Name = {{APIString|"MyNewVariable"}}
  NewVariable.Name = {{APIString|"MyNewVariable"}}
   
   
  {{APIComment|'Add the new variable to project #1.}}
  {{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)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Create a new variable. The following example creates a variable named "MyNewVariable."}}
  {{APIComment|'Create a new variable. The following example creates a variable named "MyNewVariable."}}
  {{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.}}
  {{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 16:01, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new variable resource to project. 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

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