Repository.Model.GetModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} == Declaration == {{APIPrefix|Public Function}} {{APIName|GetModel(}} {{APIPrefix|ByVal}} {{APIName|ID}} {{APIPrefix|As Integ…')
 
No edit summary
 
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


== Declaration  ==


{{APIPrefix|Public Function}}
<onlyinclude>Returns a '''[[CModel Class|cModel]]''' object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.</onlyinclude>
{{APIName|GetModel(}}
{{APIPrefix|ByVal}}
{{APIName|ID}}
{{APIPrefix|As Integer}}
{{APIName|)}}
{{APIPrefix|As}}
{{APIName|cModel}}


{{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.}}
== Syntax ==
'''.Model.GetModel'''(''ID'')
 
=== Parameters ===
''ID''
:Required. Integer. The ID number of the model to retrieve.
 
 
== Example ==
This example assumes that a model with ID #47 exists in the first project of a Synthesis repository.
 
'''VBA'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
{{APIComment|'Get model #47 from project#1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
{{APIComment|'Output sample: Display the name and ID of the model.}}
  {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ({{APIString|"You got "}} & ModelName & {{APIString|", ID#"}} & ModelID)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get model #47 from project#1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)
  AModel = MyRepository.Model.GetModel(47)
{{APIComment|'Output sample: Display the name and ID of the model.}}
  {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ({{APIString|"You got "}} & ModelName & {{APIString|", ID#"}} & ModelID)

Latest revision as of 18:53, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.

Syntax

.Model.GetModel(ID)

Parameters

ID

Required. Integer. The ID number of the model to retrieve.


Example

This example assumes that a model with ID #47 exists in the first project of a Synthesis repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get model #47 from project#1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)
  Set AModel = MyRepository.Model.GetModel(47)

 'Output sample: Display the name and ID of the model. 
  Dim ModelName As String
  Dim ModelID As Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ("You got " & ModelName & ", ID#" & ModelID)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Get model #47 from project#1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)
  AModel = MyRepository.Model.GetModel(47)

 'Output sample: Display the name and ID of the model. 
  Dim ModelName As String
  Dim ModelID As Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ("You got " & ModelName & ", ID#" & ModelID)