Repository.Control.UpdateXfmeaControl: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | ||
Parameters | <onlyinclude>Updates the properties of an existing Xfmea control in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> | ||
:control | |||
== Syntax == | |||
'''.Control.UpdateXfmeaControl'''(''control'') | |||
=== Parameters === | |||
''control'' | |||
:The [[CXfmeaControl Class|cXfmeaControl]] object to be updated. | |||
== Example == | |||
This example assumes that an Xfmea control with ID#1 exists in the repository. | |||
'''VBA''' | |||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get control #1 from project #1.}} | |||
{{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} MyControl = MyRepository.Control.GetXfmeaControl(1) | |||
{{APIComment|'Change the control's name to "New_Name."}} | |||
MyControl.Name = {{APIString|"New_Name"}} | |||
{{APIComment|'Apply the update to the control. Changes will be reflected in the repository.}} | |||
{{APIPrefix|Call}} MyRepository.Control.UpdateXfmeaControl(MyControl) | |||
'''VB.NET''' | |||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get control #1 from project #1.}} | |||
{{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl | |||
MyRepository.Project.SetCurrentProject(1) | |||
MyControl = MyRepository.Control.GetXfmeaControl(1) | |||
{{APIComment|'Change the control's name to "New_Name."}} | |||
MyControl.Name = {{APIString|"New_Name"}} | |||
{{APIComment|'Apply the update to the control. Changes will be reflected in the repository.}} | |||
MyRepository.Control.UpdateXfmeaControl(MyControl) | |||
Revision as of 18:46, 21 July 2015
 |
Member of: SynthesisAPI10.Repository
Updates the properties of an existing Xfmea control in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Syntax
.Control.UpdateXfmeaControl(control)
Parameters
control
- The cXfmeaControl object to be updated.
Example
This example assumes that an Xfmea control with ID#1 exists in the repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get control #1 from project #1. Dim MyControl As cXfmeaControl MyRepository.Project.SetCurrentProject(1) Set MyControl = MyRepository.Control.GetXfmeaControl(1) 'Change the control's name to "New_Name." MyControl.Name = "New_Name" 'Apply the update to the control. Changes will be reflected in the repository. Call MyRepository.Control.UpdateXfmeaControl(MyControl)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get control #1 from project #1. Dim MyControl As cXfmeaControl MyRepository.Project.SetCurrentProject(1) MyControl = MyRepository.Control.GetXfmeaControl(1) 'Change the control's name to "New_Name." MyControl.Name = "New_Name" 'Apply the update to the control. Changes will be reflected in the repository. MyRepository.Control.UpdateXfmeaControl(MyControl)