Repository.Variable.UpdateVariable: Difference between revisions

Latest revision as of 17:42, 9 June 2016

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-Updates the Variable
-== Method Syntax==
-{{APIName|'''UpdateVariable'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|var}}
-{{APIPrefix|As}}
-{{APIName|[[cVariable Class|cVariable]])}}
-{{APIPrefix|As Boolean}}<br>
-{{APIComment|Updates the Variable in the repository.}}
-== Parameters ==
-'''var'''
-{{APIComment|The updated variable.}}
-== Usage Example ==
+<onlyinclude>Updates the properties of a given variable resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
-{{APIComment|Declare a new repository connection class.}}
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
+== Syntax ==
-        Dim Success As Boolean = False
+ '''.Variable.UpdateVariable'''(''var'')
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Get the list of Variables in the connected repository.}}
+=== Parameters ===
-        Dim ListOfVariables() As [[cVariable Class|cVariable]]
+''var''
-        ListOfVariables= MyRepository.GetAllVariables()
+: Required. The [[CVariable Class|cVariable]] object that represents the variable resource to be updated.
-{{APIComment|Update the variable and update the repository.}}
-        Dim SuccessUpdateVariable As Boolean
+== Example ==
-        SuccessUpdateVariable = MyRepository.UpdateVariable(ListOfVariables(0))
+This example assumes that a variable with ID #1 exists in the first available project of a repository.
+ '''VBA'''
+ {{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)
+   {{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)

Repository.Variable.UpdateVariable: Difference between revisions

Latest revision as of 17:42, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search