Repository.Variable.UpdateVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.UpdateVariable.Cmt}} {{Template:BooleanReturn.Cmt}}


==Syntax==
*UpdateVariable( var {{APIPrefix|As}}[[cVariable Class|cVariable]] ){{APIPrefix|As Boolean}}


Parameters
<onlyinclude>Updates the properties of a given variable resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> 
:''var'': The [[cVariable Class|cVariable]] to update.


== Usage Example ==
== Syntax ==
  {{APIComment|'Declare a new repository connection object.}}
'''.Variable.UpdateVariable'''(''var'')
  Dim MyRepository As New Repository
 
 
=== Parameters ===
  {{APIComment|'Connect to the Synthesis repository.}}
''var''
  Dim Success As Boolean = False
: Required. The [[CVariable Class|cVariable]] object that represents the variable resource to be updated.
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
 
  {{APIComment|'Get the list of variables in the connected repository.}}
== Example ==
  Dim ListOfVariables() As [[cVariable Class|cVariable]]
This example assumes that a variable with ID #1 exists in the first available project of a repository.
  ListOfVariables= MyRepository.GetAllVariables()
 
 
'''VBA'''
  {{APIComment|'Update the variable and update the repository.}}
  Dim SuccessUpdateVariable As Boolean
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  SuccessUpdateVariable = MyRepository.UpdateVariable(ListOfVariables(0))
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get variable #1 from project #1.}}
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  MyRepository.Project.SetCurrentProject(1) 
  {{APIPrefix|Set}} MyVariable = MyRepository.Variable.GetVariable(1)
  {{APIComment|'Change the variable's name to "New_Name."}}
  MyVariable.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get variable #1 from project #1.}}
  {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
  MyRepository.Project.SetCurrentProject(1)
  MyVariable = MyRepository.Variable.GetVariable(1)
  {{APIComment|'Change the variable's name to "New_Name."}}
  MyVariable.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Variable.UpdateVariable(MyVariable)

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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Variable.UpdateVariable&oldid=64277"