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: | ||
{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}} | {{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}} | ||
{{Template:APIBreadcrumb|10|Repository}} | |||
{{Template:API}} | |||
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. | |||
== Syntax== | |||
''object''.'''Model.GetAllModelsInfo()''' | |||
where ''object'' is a variable that represents a Repository object. | |||
== Example == | |||
'''VBA|VB.NET''' | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...'Add code to connect to a Synthesis repository.}} | |||
{{ | {{APIComment|'Get a list of all models in project #1.}} | ||
{{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} NameIDPair | |||
MyRepository.Project.SetCurrentProject (1) | |||
ListofModels = MyRepository.Model.GetAllModelsInfo() | |||
{{APIComment|'Output sample: Display the name and ID of the first available model in the project.}} | |||
{{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer | |||
ModelName = ListofModels(0).Name | |||
ModelID = ListofModels(0).ID | |||
MsgBox ({{APIString|"The first model is: "}} & ModelName & {{APIString|", ID#"}} & ModelID) | |||
Revision as of 21:12, 14 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: SynthesisAPI10Repository
 |
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
object.Model.GetAllModelsInfo()
where object is a variable that represents a Repository object.
Example
VBA|VB.NET Dim MyRepository As New Repository ...'Add code to connect to a Synthesis 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)