Repository.Variable.UpdateVariable

Member of: SynthesisAPI10.Repository

Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Variable.UpdateVariable(var)

Parameters

var

The cVariable object to be updated.

Example

This example assumes that a variable with ID#1 exists in the repository.

VBA

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

 
 'Get variable #1 from project #1. 
 Dim MyVariable As cVariable
 MyRepository.Project.SetCurrentProject(1)  
 Set MyVariable = MyRepository.Variable.GetVariable(1)

 'Change the variable's name to "New_Name." 
 MyVariable.Name = "New_Name"

 'Apply the update to the variable. Changes will be reflected in the repository. 
 Call MyRepository.Variable.UpdateVariable(MyVariable)

VB.NET

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

 
 'Get variable #1 from project #1. 
 Dim MyVariable As cVariable
 MyRepository.Project.SetCurrentProject(1)  
 MyVariable = MyRepository.Variable.GetVariable(1)

 'Change the variable's name to "New_Name." 
 MyVariable.Name = "New_Name"

 'Apply the update to the variable. Changes will be reflected in the repository. 
 MyRepository.Variable.UpdateVariable(MyVariable)