Repository.Model.GetAllModelsInfo: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} == Declaration == {{APIPrefix|Public Function}} {{APIName|GetAllModelsInfo()}} {{APIPrefix|As}} {{APIName|NameIdPair()}} {{A…') |
Kate Racaza (talk | contribs) No edit summary |
||
| (39 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:DeprecatedAPI}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
{{ | <onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Returns an array of '''[[NameIdPair_Class|NameIdPair]]''' objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).</onlyinclude> | ||
{{APIComment| | == Syntax== | ||
'''.Model.GetAllModelsInfo'''(''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 models 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 local models in project #1.}} | |||
{{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} NameIDPair | |||
MyRepository.Project.SetCurrentProject (1) | |||
ListofModels = MyRepository.Model.GetAllModelsInfo() | |||
{{APIComment|'Output sample: Display the number of models in the project.}} | |||
{{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | |||
NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1 | |||
MsgBox (NumberofElements) | |||
Latest revision as of 18:53, 9 June 2016
 |
This method has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications.
Member of: SynthesisAPI.Repository
Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).
Syntax
.Model.GetAllModelsInfo(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 models 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 local models in project #1. Dim ListofModels() As NameIDPair MyRepository.Project.SetCurrentProject (1) ListofModels = MyRepository.Model.GetAllModelsInfo() 'Output sample: Display the number of models in the project. Dim NumberofElements As Integer NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1 MsgBox (NumberofElements)