Repository.Variable.UpdateVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}
 
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.   
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.   
 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Variable.UpdateVariable(''var'')'''
''object''.'''Variable.UpdateVariable(''var'')'''
Line 11: Line 11:
{| {{APITable}}
{| {{APITable}}
|-
|-
|var{{APIParam|Required}}||The '''[[CVariable Class|cVariable]]''' object to be updated.
|var{{APIParam|Required}}||The [[CVariable Class|cVariable]] object to be updated.
|}
|}


Line 28: Line 28:
   {{APIPrefix|Set}} MyVariable = MyRepository.Variable.GetVariable(1)
   {{APIPrefix|Set}} MyVariable = MyRepository.Variable.GetVariable(1)
   
   
  {{APIComment|'Change the variable's name to "New_Name".}}
  {{APIComment|'Change the variable's name to "New_Name."}}
   MyVariable.Name = "New_Name"
   MyVariable.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}}
Line 44: Line 44:
   MyURD = MyRepository.URD.GetURD(1)
   MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Change the URD's name to "New_Name".}}
  {{APIComment|'Change the URD's name to "New_Name."}}
   MyURD.Name = "New_Name"
   MyURD.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
   MyRepository.URD.UpdateURD(MyURD)
   MyRepository.URD.UpdateURD(MyURD)
</noinclude>

Revision as of 21:54, 16 July 2015

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)