Repository.Variable.UpdateVariable: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | {{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | ||
<onlyinclude> | |||
<onlyinclude>Applies any changes made to an existing variable resource. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> | |||
== 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 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 in a repository. | ||
'''VBA''' | '''VBA''' | ||
| Line 28: | Line 30: | ||
MyVariable.Name = {{APIString|"New_Name"}} | MyVariable.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the | {{APIComment|'Apply the change to the variable. Changes are recorded in the Synthesis repository.}} | ||
{{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable) | {{APIPrefix|Call}} MyRepository.Variable.UpdateVariable(MyVariable) | ||
| Line 46: | Line 48: | ||
MyVariable.Name = {{APIString|"New_Name"}} | MyVariable.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the | {{APIComment|'Apply the change to the variable. Changes are recorded in the Synthesis repository.}} | ||
MyRepository.Variable.UpdateVariable(MyVariable) | MyRepository.Variable.UpdateVariable(MyVariable) | ||
Revision as of 20:54, 24 August 2015
 |
Member of: SynthesisAPI10.Repository
Applies any changes made to an existing variable resource. Returns a Boolean value; when true, indicates a successful save.
Syntax
.Variable.UpdateVariable(var)
Parameters
var
- Required. The cVariable object to be updated.
Example
This example assumes that a variable with ID #1 exists in the first available project in a repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New 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 change to the variable. Changes are recorded in the Synthesis repository. Call MyRepository.Variable.UpdateVariable(MyVariable)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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" 'Apply the change to the variable. Changes are recorded in the Synthesis repository. MyRepository.Variable.UpdateVariable(MyVariable)