Repository.Control.GetAllXfmeaControls: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} Returns an array containing all XfmeaControls from the current project. == Syntax== *GetAllXfmeaControls() {{APIPrefix|As}} cXf…') |
Kate Racaza (talk | contribs) No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
== Syntax== | |||
<onlyinclude>Returns an array of '''[[CXfmeaControl Class|cXfmeaControl]]''' objects that represent the Xfmea controls in the current project.</onlyinclude> | |||
== 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 Enumeration|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''' | |||
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{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 number of controls in the project.}} | |||
{{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | |||
NumberofElements = UBound(ListofControls) - LBound(ListofControls) + 1 | |||
MsgBox (NumberofElements) | |||
Latest revision as of 18:52, 9 June 2016
 |
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)