Repository.Model.GetAllModelsInfo: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:DeprecatedAPI}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>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.<includeonly>{{DeprecatedAPIpic}}</includeonly></onlyinclude>
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Returns an array of '''[[NameIdPair_Class|NameIdPair]]''' objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).</onlyinclude>


== Syntax==
== Syntax==
  '''.Model.GetAllModelsInfo()'''
  '''.Model.GetAllModelsInfo'''(''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.




Line 11: Line 15:
This example assumes that models exist in the first available project of a repository.
This example assumes that models exist in the first available project of a repository.
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
 
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get a list of all local models in project #1.}}
  {{APIComment|'Get a list of all models in project #1.}}
  {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} NameIDPair
  {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} NameIDPair
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  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 models in the project.}}
  {{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)

Latest revision as of 18:53, 9 June 2016

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.


Member of: SynthesisAPI.Repository


Returns an array of NameIdPair objects that represent the name and ID pairs of the model resources in the current project. This includes internal models automatically created with any new repository (model ID#s 1 to 20).

Syntax

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

 'Output sample: Display the number of models in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.GetAllModelsInfo&oldid=64317"