Repository.Control.GetAllXfmeaControls: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<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>Returns an array of '''[[CXfmeaControl Class|cXfmeaControl]]''' objects that represent the Xfmea controls in the current project.</onlyinclude>   


== Syntax ==
== Syntax ==
  '''.Control.GetAllXfmeaControls()'''
  '''.Control.GetAllXfmeaControls'''(''Filter'')
 
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.




Line 13: Line 17:
  '''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 description and ID# of the first available control in the project.}}
  {{APIComment|'Output sample: Display the number of controls in the project.}}
  {{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)

Latest revision as of 18:52, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cXfmeaControl objects that represent the Xfmea controls in the current project.

Syntax

.Control.GetAllXfmeaControls(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Control.GetAllXfmeaControls&oldid=64311"