Repository.Control.UpdateXfmeaControl: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<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>   
<onlyinclude>Applies any changes made to an existing Xfmea control. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 9: Line 9:
=== Parameters ===
=== Parameters ===
''control''
''control''
:The [[CXfmeaControl Class|cXfmeaControl]] object to be updated.
:Required. The [[CXfmeaControl Class|cXfmeaControl]] object to be updated.




== Example ==
== Example ==
This example assumes that an Xfmea control with ID#1 exists in the repository.
This example assumes that an Xfmea control with ID #1 exists in the first available project in a repository.


  '''VBA'''
  '''VBA'''
Line 30: Line 30:
   MyControl.Name = {{APIString|"New_Name"}}
   MyControl.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the control. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the Xfmea control. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Control.UpdateXfmeaControl(MyControl)
   {{APIPrefix|Call}} MyRepository.Control.UpdateXfmeaControl(MyControl)


Line 48: Line 48:
   MyControl.Name = {{APIString|"New_Name"}}
   MyControl.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the control. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the Xfmea control. Changes are recorded in the Synthesis repository.}}
   MyRepository.Control.UpdateXfmeaControl(MyControl)
   MyRepository.Control.UpdateXfmeaControl(MyControl)

Revision as of 21:07, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing Xfmea control. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Control.UpdateXfmeaControl(control)

Parameters

control

Required. The cXfmeaControl object to be updated.


Example

This example assumes that an Xfmea control 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 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 change to the Xfmea control. Changes are recorded in the Synthesis 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 change to the Xfmea control. Changes are recorded in the Synthesis repository. 
 MyRepository.Control.UpdateXfmeaControl(MyControl)