Repository.Model.GetAllModelsInfo: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Gets a list of models associated with a project. Returns a '''[[NameIdPair_Class|NameIdPair]]''' object | <onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Gets a list of models associated with a project. Returns a '''[[NameIdPair_Class|NameIdPair]]''' object that represents the name and ID pairs of the models. This includes internal models automatically created with any new repository (model ID#s 1 to 20).</onlyinclude> | ||
== Syntax== | == Syntax== | ||
| Line 15: | Line 15: | ||
This example assumes that models exist in the first available project of a repository. | This example assumes that models exist in the first available project of a repository. | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
{{APIComment|' | {{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 | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get a list of all local models in project #1.}} | {{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 elements in the array.}} | {{APIComment|'Output sample: Display the number of elements in the array.}} | ||
{{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | |||
NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1 | |||
MsgBox (NumberofElements) | |||
Revision as of 17:41, 8 April 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
Gets a list of models associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the models. 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 elements in the array. Dim NumberofElements As Integer NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1 MsgBox (NumberofElements)