Repository.Model.GetAllModels: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Returns an array of cModel objects that represent the model resources in the current project.

Syntax

.Model.GetAllModels(Filter)

Parameters

Filter

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

Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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 models in the array. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
  MsgBox (NumberofElements)

@@ Line 1: / Line 1: @@
-{{Template:APIBreadcrumb|10|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{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.
+<onlyinclude>Returns an array of '''[[CModel Class|cModel]]''' objects that represent the model resources in the current project.</onlyinclude>
 == Syntax ==
-''object''.'''Model.GetAllModels()'''
+ '''.Model.GetAllModels'''(''Filter'')
+===Parameters===
+''Filter''
+:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.
-where ''object'' is a variable that represents a Repository object.
 == Example ==
@@ Line 13: / Line 17: @@
   '''VBA|VB.NET'''
-  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
- {{APIComment|...'Add code to connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  {{APIComment|'Get a list of all models in project #1.}}
-  {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
+  {{APIComment|'Get a list of all local models in project #1.}}
-  MyRepository.Project.SetCurrentProject (1)
+   {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
-  ListofModels = MyRepository.Model.GetAllModels()
+   MyRepository.Project.SetCurrentProject (1)
+   ListofModels = MyRepository.Model.GetAllModels()
-  {{APIComment|'Output sample: Display the name and ID of the first available model in the project.}}
+  {{APIComment|'Output sample: Display the number of models 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)

Repository.Model.GetAllModels: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search