Repository.Control.GetAllXfmeaControls: Difference between revisions

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




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


== Syntax ==
== Syntax ==
Line 13: Line 13:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get a list of all Xfmea controls in project #1.}}
  {{APIComment|'Get a list of all Xfmea controls in project #1.}}
  {{APIPrefix|Dim}} ListofControls() {{APIPrefix|As}} cXfmeaControl
  {{APIPrefix|Dim}} ListofControls() {{APIPrefix|As}} cXfmeaControl
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  ListofControls = MyRepository.Control.GetAllXfmeaControls()
  ListofControls = MyRepository.Control.GetAllXfmeaControls()
   
   
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIComment|'Output sample: Display the number of controls in the project.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1
  NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1
  MsgBox (NumberofElements)
  MsgBox (NumberofElements)

Revision as of 17:33, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets a list of Xfmea controls associated with a project. Returns a cXfmeaControl object that represents the control resources.

Syntax

.Control.GetAllXfmeaControls()


Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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 controls in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1
  MsgBox (NumberofElements)