Repository.Variable.UpdateVariable: Difference between revisions

Revision as of 18:03, 27 February 2014

Updates the variable in the repository. Returns True if successful, otherwise returns False.

UpdateVariable( var AscVariable )As Boolean

Parameters

var: The cVariable to update.

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of Variables in the connected repository.

       Dim ListOfVariables() As cVariable
       ListOfVariables= MyRepository.GetAllVariables()

Update the variable and update the repository.

       Dim SuccessUpdateVariable As Boolean
       SuccessUpdateVariable = MyRepository.UpdateVariable(ListOfVariables(0))

@@ Line 1: / Line 1: @@
 {{Template:APIClass|Repository Class|Repository}}
-Updates the Variable
+{{Template:Repository.UpdateVariable.Cmt}} {{Template:BooleanReturn.Cmt}}
-== 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 ==
+==Syntax==
-'''var'''
+UpdateVariable( var {{APIPrefix|As}}[[cVariable Class|cVariable]] ){{APIPrefix|As Boolean}}
-{{APIComment|The updated variable.}}
+Parameters
+:''var'': The [[cVariable Class|cVariable]] to update.
 == Usage Example ==