Repository.Model.GetAllModelsInfo

From ReliaWiki
Revision as of 00:12, 1 March 2016 by Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter)
Jump to navigation Jump to search
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 a list of models associated with a project. Returns a NameIdPair object array that contains the models in that 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
 
 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

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