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: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude> | ||
Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. | |||
<noinclude> | <noinclude> | ||
== Syntax == | == Syntax == | ||
' | '''.Variable.UpdateVariable'''(''var'') | ||
=== Parameters === | === Parameters === | ||
''var'' | |||
:The [[CVariable Class|cVariable]] object to be updated. | |||
| Line 20: | Line 15: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get variable #1 from project #1.}} | {{APIComment|'Get variable #1 from project #1.}} | ||
| Line 36: | Line 33: | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get | {{APIComment|'Get variable #1 from project #1.}} | ||
{{APIPrefix|Dim}} | {{APIPrefix|Dim}} MyVariable {{APIPrefix|As}} cVariable | ||
MyRepository.Project.SetCurrentProject(1) | MyRepository.Project.SetCurrentProject(1) | ||
MyVariable = MyRepository.Variable.GetVariable(1) | |||
{{APIComment|'Change the | {{APIComment|'Change the variable's name to "New_Name."}} | ||
MyVariable.Name = {{APIString|"New_Name"}} | |||
{{APIComment|'Apply the update to the | {{APIComment|'Apply the update to the variable. Changes will be reflected in the repository.}} | ||
MyRepository. | MyRepository.Variable.UpdateVariable(MyVariable) | ||
</noinclude> | </noinclude> | ||
Revision as of 20:25, 20 July 2015
 |
Member of: SynthesisAPI10.Repository
Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Syntax
.Variable.UpdateVariable(var)
Parameters
var
- The cVariable object to be updated.
Example
This example assumes that a variable with ID#1 exists in the 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 update to the variable. Changes will be reflected in the 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 update to the variable. Changes will be reflected in the repository. MyRepository.Variable.UpdateVariable(MyVariable)