Repository.Variable.UpdateVariable

From ReliaWiki
Revision as of 21:54, 16 July 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI10Repository

Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

Syntax

object.Variable.UpdateVariable(var)

where object is a variable that represents a Repository object.

Parameters

Name Description
varborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cVariable object to be updated.


Example

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

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository. 
 
 'Get URD #1 from project #1. 
 Dim MyURD As cURD
 MyRepository.Project.SetCurrentProject(1)  
 MyURD = MyRepository.URD.GetURD(1)

 'Change the URD's name to "New_Name." 
 MyURD.Name = "New_Name"

 'Apply the update to the URD. Changes will be reflected in the repository. 
 MyRepository.URD.UpdateURD(MyURD)