Repository.Model.IsModelUsed: Difference between revisions

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




<onlyinclude>Checks whether the model with the designated ID number is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>  
<onlyinclude>Checks whether the model is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>  


== Syntax ==
== Syntax ==
Line 16: Line 16:
  '''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|'Check whether model #42 from project #1 is in use.}}
  {{APIComment|'Check whether model #42 from project #1 is in use.}}
  {{APIPrefix|Dim}} CheckModel {{APIPrefix|As Boolean}}
  {{APIPrefix|Dim}} CheckModel {{APIPrefix|As Boolean}}
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  CheckModel = MyRepository.Model.IsModelUsed(42)
  CheckModel = MyRepository.Model.IsModelUsed(42)
   
   
  {{APIComment|'Output sample.}}
  {{APIComment|'Output sample.}}
  {{APIPrefix|If}} CheckModel = {{APIPrefix|True Then}}
  {{APIPrefix|If}} CheckModel = {{APIPrefix|True Then}}
    MsgBox ({{APIString|"The model is in use."}})
    MsgBox ({{APIString|"The model is in use."}})
  {{APIPrefix|Else}}
  {{APIPrefix|Else}}
    MsgBox ({{APIString|"The model is not in use."}})
    MsgBox ({{APIString|"The model is not in use."}})
  {{APIPrefix|End If}}
  {{APIPrefix|End If}}

Latest revision as of 18:57, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Checks whether the model is used by other items in the project. Returns a Boolean value; when true, indicates that the model is in use.

Syntax

.Model.IsModelUsed(ID)

Parameters

ID

Required. Integer. The ID number of the model to be checked.


Example

This example assumes that a model with ID #42 exists in the first available project of a Synthesis 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")
  
 'Check whether model #42 from project #1 is in use. 
  Dim CheckModel As Boolean
  MyRepository.Project.SetCurrentProject(1)  
  CheckModel = MyRepository.Model.IsModelUsed(42)

 'Output sample. 
  If CheckModel = True Then
    MsgBox ("The model is in use.")
  Else
    MsgBox ("The model is not in use.")
  End If