Repository.Model.IsModelUsed: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}




Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.  
<onlyinclude>Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>  
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Model.IsModelUsed'''(''ID'')
  '''.Model.IsModelUsed'''(''ID'')
Line 32: Line 32:
     MsgBox ({{APIString|"The model is not in use."}})
     MsgBox ({{APIString|"The model is not in use."}})
   {{APIPrefix|End If}}
   {{APIPrefix|End If}}
</noinclude>

Revision as of 22:13, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Checks whether the model with the ID number that you specify 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

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 in a repository.

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
 Dim MyRepository As New Repository
 ... 
 

 'Check whether model #42 from project #1 is in use. 
 MyRepository.Project.SetCurrentProject(1)  
 
 Dim CheckModel As Boolean
 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