Repository.Variable.UpdateVariable: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:Repository.UpdateVariable.Cmt}} {{Template:BooleanReturn.Cmt}}
{{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.


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


Parameters
where ''object'' is a variable that represents a Repository object.
:''var'': The [[cVariable Class|cVariable]] to update.


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
|var{{APIParam|Required}}||The '''[[CVariable Class|cVariable]]''' object to be updated.
|}
 
 
== Example ==
This example assumes that a variable with ID#1 exists in the repository.
 
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Get variable #1 from project #1.}}
   Dim Success As Boolean = False
   {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  MyRepository.Project.SetCurrentProject(1) 
   {{APIPrefix|Set}} MyVariable = MyRepository.Variable.GetVariable(1)
{{APIComment|'Change the variable's name to "New_Name".}}
  MyVariable.Name = "New_Name"
{{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}}
  {{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable)
 
'''VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Get URD #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
   MyRepository.Project.SetCurrentProject(1) 
  MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Get the list of variables in the current project.}}
  {{APIComment|'Change the URD's name to "New_Name".}}
   Dim ListOfVariables() As [[cVariable Class|cVariable]]
   MyURD.Name = "New_Name"
  ListOfVariables= MyRepository.Variable.GetAllVariables()
 
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'Update the variable and update the repository.}}
   MyRepository.URD.UpdateURD(MyURD)
   Dim SuccessUpdateVariable As Boolean
  SuccessUpdateVariable = MyRepository.Variable.UpdateVariable(ListOfVariables(0))

Revision as of 23:34, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


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