Repository.Variable.UpdateVariable

From ReliaWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given variable resource in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Variable.UpdateVariable(var)

Parameters

var

Required. The cVariable object that represents the variable resource to be updated.


Example

This example assumes that a variable with ID #1 exists in the first available project of a repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Variable.UpdateVariable(MyVariable)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  MyRepository.Variable.UpdateVariable(MyVariable)