User:Kate Racaza/APIdraftspage: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em;"> '''New Classes''' '''New Enums''' '''Methods''' *[[Rep…')
 
No edit summary
Line 15: Line 15:




<onlyinclude>Gets a list of local models associated with a project. Returns a '''[[CModel Class|cModel]]''' object array that contains all the models in that project.</onlyinclude>  
<onlyinclude>Gets a list of models associated with a project. Returns a '''[[CModel Class|cModel]]''' object array that contains the models in that project.</onlyinclude>  


== Syntax ==
== Syntax ==
Line 35: Line 35:
   
   
    
    
  {{APIComment|'Get a list of all models in project #1.}}
  {{APIComment|'Get a list of all local models in project #1.}}
   {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
   {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
   MyRepository.Project.SetCurrentProject (1)   
   MyRepository.Project.SetCurrentProject (1)   

Revision as of 17:16, 4 November 2015

New Classes

New Enums

Methods


Repository.Model.GetAllModels

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of models associated with a project. Returns a cModel object array that contains the models in that project.

Syntax

.Model.GetAllModels(Filter)

Parameter

Filter

Optional. A filter that returns a particular type of model resource (e.g., global models only, local and global models only, etc.). Can be any ResourceFilterEnum constant. Default value = LocalOnly.


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 cModel
 MyRepository.Project.SetCurrentProject (1)  
 ListofModels = MyRepository.Model.GetAllModels()

 'Output sample: Display the number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
 MsgBox (NumberofElements)