Repository.Model.GetModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.GetModel" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}
Gets a Model from the connected repository.
{{Template:Repository.GetModel.Cmt}}


== Method Syntax==
== Syntax==
{{APIName|'''GetModel'''(}}
*GetModel( ID{{APIPrefix|As Integer}}){{APIPrefix|As}}[[cModel Class|cModel]]
{{APIPrefix|ByVal}}
{{APIName|ID}}
{{APIPrefix|As Integer}}
{{APIName|)}}
{{APIPrefix|As}}
{{APIName|[[cModel Class|cModel]]}}<br>
{{APIComment|Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.}}


== Parameters ==
Parameters
'''ID'''
:''ID'': The ID of the model to retrieve.
The ID of the model to retrieve.


== Usage Example ==
== Usage Example ==

Revision as of 17:30, 27 February 2014


Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.

Syntax

  • GetModel( IDAs Integer)AscModel

Parameters

ID: The ID of the model to retrieve.

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of Models in the connected repository.

       Dim ListOfModels() As NameIdPair
       ListOfModels = MyRepository.GetAllModelsInfo()

Select the ID of the model and retrieve it. In this example, the first model is used.

       Dim AModel as cModel
       AModel = MyRepository.GetModel(ListOfModels(0).ID)