Repository.Model.DeleteModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}
{{Template:API}}
Deletes an unused model from the Synthesis repository. Throws an exception if the model is in use. Returns a '''Boolean''' value; when true, indicates that the model does not exist.  
Deletes an unused model from the Synthesis repository. Throws an exception if the model is in use. Returns a '''Boolean''' value; when true, indicates that the model no longer exists.  


== Syntax ==
== Syntax ==

Revision as of 21:32, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


Deletes an unused model from the Synthesis repository. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates that the model no longer exists.

Syntax

object.Model.DeleteModel(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)