Repository.Control.GetAllXfmeaControls: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} Returns an array containing all XfmeaControls from the current project. == Syntax== *GetAllXfmeaControls() {{APIPrefix|As}} cXf…')
 
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
Returns an array containing all XfmeaControls from the current project.


== Syntax==
 
*GetAllXfmeaControls() {{APIPrefix|As}} cXfmeaControl()
<onlyinclude>Gets a list of all existing Xfmea controls in the current project. Returns a '''[[CXfmeaControl Class|cXfmeaControl]]''' object array that contains the control names, ID numbers and other information.</onlyinclude> 
 
== Syntax ==
'''.Control.GetAllXfmeaControls()'''
 
 
== Example ==
This example assumes that Xfmea controls exist in the first available project of a repository.
 
'''VBA|VB.NET'''
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
 
{{APIComment|'Get a list of all Xfmea controls in project #1.}}
  {{APIPrefix|Dim}} ListofControls() {{APIPrefix|As}} cXfmeaControl
  MyRepository.Project.SetCurrentProject (1) 
  ListofControls = MyRepository.Control.GetAllXfmeaControls()
{{APIComment|'Output sample: Display the description and ID# of the first available control in the project.}}
  {{APIPrefix|Dim}} ControlName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ControlID {{APIPrefix|As}} Integer
  ControlName = ListofControls(0).Name
  ControlID = ListofControls(0).ID
  MsgBox (ControlName & ControlID)

Revision as of 18:27, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all existing Xfmea controls in the current project. Returns a cXfmeaControl object array that contains the control names, ID numbers and other information.

Syntax

.Control.GetAllXfmeaControls()


Example

This example assumes that Xfmea controls exist in the first available project of a repository.

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 'Get a list of all Xfmea controls in project #1. 
 Dim ListofControls() As cXfmeaControl
 MyRepository.Project.SetCurrentProject (1)  
 ListofControls = MyRepository.Control.GetAllXfmeaControls()

 'Output sample: Display the description and ID# of the first available control in the project. 
 Dim ControlName As String
 Dim ControlID As Integer
 ControlName = ListofControls(0).Name
 ControlID = ListofControls(0).ID
 MsgBox (ControlName & ControlID)