Repository.Model.GetAllModelsInfo: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}{{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 '''[[NameIdPair_Class|NameIdPair]]''' object array that contains the model names and their ID numbers. | 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. | ||
<noinclude> | <noinclude> | ||
== Syntax== | == Syntax== | ||
' | '''.Model.GetAllModelsInfo()''' | ||
== Example == | == Example == | ||
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.}} | |||
{{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}} NameIDPair | {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} NameIDPair | ||
Revision as of 17:53, 20 July 2015
 |
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 all existing local models in the current project (does not include global or reference models). Returns a NameIdPair object array that contains the model names and their ID numbers.
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 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)