Repository.Model.IsModelUsed: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude>Checks whether the model with the ID number | <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> | ||
== Syntax == | == Syntax == | ||
'''.Model.IsModelUsed'''(''ID'') | '''.Model.IsModelUsed'''(''ID'') | ||
=== Parameters === | === Parameters === | ||
''ID'' | ''ID'' | ||
:Integer. The ID number of the model to be checked. | :Required. Integer. The ID number of the model to be checked. | ||
== Example == | == Example == | ||
This example assumes that a model with ID# 42 exists in the first available project | This example assumes that a model with ID #42 exists in the first available project of a Synthesis repository. | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
| Line 21: | Line 22: | ||
{{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}} | |||
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."}}) | ||
Revision as of 23:43, 24 August 2015
 |
Member of: SynthesisAPI10.Repository
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.
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 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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