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>Gets a list of all existing local models in the current project (does not include global or reference models). Returns a '''[[NameIdPair_Class|NameIdPair]]''' object array that contains the model names and their ID numbers.<includeonly>[[Image:DeprecatedAPI.png]]</includeonly></onlyinclude>
<onlyinclude>Gets a list of all existing local models in the current project (does not include global or reference models). Returns a '''[[NameIdPair_Class|NameIdPair]]''' object array that contains the model names and their ID numbers.<includeonly>{{DeprecatedAPIpic}}</includeonly></onlyinclude>


== Syntax==
== Syntax==

Revision as of 21:05, 11 August 2015

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. Repository.Model.GetAllModels


Member of: SynthesisAPI10.Repository


Gets a list of all existing local models in the current project (does not include global or reference models). Returns a NameIdPair object array that contains the model names and their ID numbers.

Syntax

.Model.GetAllModelsInfo()


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 models in project #1. 
 Dim ListofModels() As NameIDPair
 MyRepository.Project.SetCurrentProject (1)  
 ListofModels = MyRepository.Model.GetAllModelsInfo()

 'Output sample: Display the name and ID of the first available model in the project. 
 Dim ModelName As String
 Dim ModelID As Integer
 ModelName = ListofModels(0).Name
 ModelID = ListofModels(0).ID
 MsgBox ("The first model is: " & ModelName & ", ID#" & ModelID)