Repository.Variable.UpdateVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Updates the properties of a given variable resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>


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. 
<noinclude>
== Syntax ==
== Syntax ==
  '''.Variable.UpdateVariable'''(''var'')
  '''.Variable.UpdateVariable'''(''var'')
=== Parameters ===
=== Parameters ===
''var''
''var''
:The [[CVariable Class|cVariable]] object to be updated.
: Required. The [[CVariable Class|cVariable]] object that represents the variable resource to be updated.




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


  '''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|'Get variable #1 from project #1.}}
  {{APIComment|'Get variable #1 from project #1.}}
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{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 = {{APIString|"New_Name"}}
  MyVariable.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable)
  {{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable)


  '''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|'Get variable #1 from project #1.}}
  {{APIComment|'Get variable #1 from project #1.}}
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyVariable = MyRepository.Variable.GetVariable(1)
  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 = {{APIString|"New_Name"}}
  MyVariable.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Variable.UpdateVariable(MyVariable)
  MyRepository.Variable.UpdateVariable(MyVariable)
</noinclude>

Latest revision as of 17:42, 9 June 2016

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)