Repository.Control.GetAllXfmeaControls: Difference between revisions

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




<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>   
<onlyinclude>Gets a list of Xfmea controls associated with a project. Returns a '''[[CXfmeaControl Class|cXfmeaControl]]''' object array that contains all the Xfmea controls in that project.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofControls = MyRepository.Control.GetAllXfmeaControls()
   ListofControls = MyRepository.Control.GetAllXfmeaControls()
   
   
  {{APIComment|'Output sample: Display the description and ID# of the first available control in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} ControlName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} ControlID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1
   ControlName = ListofControls(0).Name
   MsgBox (NumberofElements)
  ControlID = ListofControls(0).ID
   MsgBox (ControlName & ControlID)

Revision as of 22:59, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of Xfmea controls associated with a project. Returns a cXfmeaControl object array that contains all the Xfmea controls in that project.

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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1
 MsgBox (NumberofElements)