Repository.Model.DeleteModel: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}} | |||
Deletes an unused model from the current project. Returns a '''Boolean''' value; when true, indicates a successful deletion. | <onlyinclude>Deletes an unused model from the current project. Returns a '''Boolean''' value; when true, indicates a successful deletion.</onlyinclude> | ||
Throws an exception if the model is in use. | Throws an exception if the model is in use. | ||
== Syntax == | == Syntax == | ||
'''.Model.DeleteModel'''(''ID'') | '''.Model.DeleteModel'''(''ID'') | ||
| Line 25: | Line 25: | ||
MyRepository.Project.SetCurrentProject (1) | MyRepository.Project.SetCurrentProject (1) | ||
MyRepository.Model.DeleteModel(71) | MyRepository.Model.DeleteModel(71) | ||
Revision as of 22:13, 20 July 2015
 |
Member of: SynthesisAPI10Repository
Deletes an unused model from the current project. Returns a Boolean value; when true, indicates a successful deletion.
Throws an exception if the model is in use.
Syntax
.Model.DeleteModel(ID)
Parameters
ID
- Integer. The ID number of the model to delete.
Example
This example assumes that an unused model with ID#71 exists in a repository.
VBA|VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Delete model #71 from project #1. The model will no longer be visible in the Synthesis repository upon refresh. MyRepository.Project.SetCurrentProject (1) MyRepository.Model.DeleteModel(71)