Repository.Control.UpdateXfmeaControl: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} Updates the XfmeaControl in the repository. ==Syntax== *UpdateXfmeaControl(ByVal control As cXfmeaControl) As Boolean Paramet…')
 
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Updates the XfmeaControl in the repository.


==Syntax==
*UpdateXfmeaControl(ByVal control As cXfmeaControl) As Boolean


Parameters
<onlyinclude>Updates the properties of a given control resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> 
control: An instance of cXfmeaControl to update.
 
== Syntax ==
'''.Control.UpdateXfmeaControl'''(''control'')
 
=== Parameters ===
''control''
:Required. The [[CXfmeaControl Class|cXfmeaControl]] object that represents the control to be updated.
 
 
== Example ==
This example assumes that an Xfmea control with ID #1 exists in the first available project in a repository.
 
'''VBA'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{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|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Control.UpdateXfmeaControl(MyControl)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{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|'Send the change to the Synthesis repository.}}
  MyRepository.Control.UpdateXfmeaControl(MyControl)

Latest revision as of 16:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given control resource in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Control.UpdateXfmeaControl(control)

Parameters

control

Required. The cXfmeaControl object that represents the control to be updated.


Example

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

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Control.UpdateXfmeaControl(MyControl)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  MyRepository.Control.UpdateXfmeaControl(MyControl)