Repository.Model.GetAllModels: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}
 
Gets a list of all existing local models in the current project (does not include global or reference models). Returns a '''[[CModel Class|cModel]]''' object array that contains the model names, ID numbers and other information.  
Gets a list of all existing local models in the current project (does not include global or reference models). Returns a '''[[CModel Class|cModel]]''' object array that contains the model names, ID numbers and other information.  
 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Model.GetAllModels()'''
''object''.'''Model.GetAllModels()'''
Line 27: Line 27:
   ModelID = ListofModels(0).ID
   ModelID = ListofModels(0).ID
   MsgBox ({{APIString|"The first model is: "}} & ModelName & {{APIString|", ID#"}} & ModelID)
   MsgBox ({{APIString|"The first model is: "}} & ModelName & {{APIString|", ID#"}} & ModelID)
</noinclude>

Revision as of 22:17, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

Syntax

object.Model.GetAllModels()

where object is a variable that represents a Repository object.

Example

This example assumes that models exist in the first available project of a repository.

VBA|VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 'Get a list of all models in project #1. 
 Dim ListofModels() As cModel
 MyRepository.Project.SetCurrentProject (1)  
 ListofModels = MyRepository.Model.GetAllModels()

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