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><includeonly>{{DeprecatedAPIpic}}</includeonly>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.</onlyinclude>
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Gets a list of local models associated with a project (does not include global or reference models). Returns a '''[[NameIdPair_Class|NameIdPair]]''' object array that contains all the models in that project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).</onlyinclude>


== Syntax==
== Syntax==
Line 22: Line 22:
   ListofModels = MyRepository.Model.GetAllModelsInfo()
   ListofModels = MyRepository.Model.GetAllModelsInfo()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available model in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
   ModelName = ListofModels(0).Name
   MsgBox (NumberofElements)
  ModelID = ListofModels(0).ID
   MsgBox ({{APIString|"The first model is: "}} & ModelName & {{APIString|", ID#"}} & ModelID)

Revision as of 23:56, 24 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 local models associated with a project (does not include global or reference models). Returns a NameIdPair object array that contains all the models in that project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).

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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
 MsgBox (NumberofElements)