Repository.Model.GetAllModelsInfo: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
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 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>
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Gets 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>


== 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|'Declare a new Repository object and 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

Revision as of 22:50, 8 June 2016

APIWiki.png


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 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)