Repository.Model.GetAllModels: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
 


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>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Model.GetAllModels()'''
'''.Model.GetAllModels()'''


where ''object'' is a variable that represents a Repository object.


== Example ==
== Example ==
Line 13: Line 13:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
 
  {{APIComment|'Get a list of all models in project #1.}}
  {{APIComment|'Get a list of all models in project #1.}}
   {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
   {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel

Revision as of 17:54, 20 July 2015

APIWiki.png


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 cModel object array that contains the model names, ID numbers and other information.

Syntax

.Model.GetAllModels()


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