Difference between revisions of "Repository.Variable.AddVariable"

From ReliaWiki
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
+
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
  
  
<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 the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
 +
 
 +
 
 +
'''Remarks''': 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.
  
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 12:
 
=== Parameters ===
 
=== Parameters ===
 
''var''
 
''var''
:The [[CVariable Class|cVariable]] object to be added. (Required)
+
:Required. The [[CVariable Class|cVariable]] object that represents the variable resource to be added.
  
  
Line 17: Line 19:
 
  '''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. 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)
  
 
  '''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. 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)

Latest revision as of 20:37, 18 August 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.


Remarks: 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)