Talk:Repository.Model.GetAllModelsInfo/Notes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Gets a list of models associated with a project. Returns a '''NameIdPair''' object array that con…')
 
No edit summary
Line 6: Line 6:
===Parameters===
===Parameters===
''Filter''
''Filter''
:Optional. A filter that returns a particular type of model resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local models only.  
: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.  





Revision as of 17:50, 13 January 2016

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)