Repository.Control.GetXfmeaControl: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 5: Line 5:


== Syntax ==
== Syntax ==
  '''Control.GetXfmeaControl'''(''ID'')
  '''.Control.GetXfmeaControl'''(''ID'')
=== Parameters ===
=== Parameters ===
''ID''
''ID''

Revision as of 17:06, 21 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the Xfmea control with the designated ID number and returns it as a cXfmeaControl object. Returns nothing if the control does not exist or is not in the current project.

Syntax

.Control.GetXfmeaControl(ID)

Parameters

ID

Integer. The ID number of the control to retrieve.


Example

This example assumes that an Xfmea control with ID#1 exists 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)

 'Output sample: Display the name and ID of the control. 
 Dim ControlName As String
 Dim ControlID As Integer
 ControlName = MyControl.Name
 ControlID = MyControl.ID
 MsgBox ("ID# " & ControlID & ", " & ControlName)
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)

 'Output sample: Display the name and ID of the control. 
 Dim ControlName As String
 Dim ControlID As Integer
 ControlName = MyControl.Name
 ControlID = MyControl.ID
 MsgBox ("ID# " & ControlID & ", " & ControlName)