Repository.Model.DeleteModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{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 no longer exists.  
 
<onlyinclude>Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a '''Boolean''' value; when true, indicates a successful deletion.</onlyinclude>


== Syntax ==
== Syntax ==
''object''.'''Model.DeleteModel(''ID'')'''
'''.Model.DeleteModel'''(''ID'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Required. Integer. The ID number of the model to delete.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the model to delete.
|}




== Example ==
== Example ==
This example assumes that an unused model with ID#71 exists in a repository.
This example assumes that an unused model with ID #71 exists in the first project of a Synthesis repository.
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Delete model #71 from project #1. The model will no longer be visible in the Synthesis repository upon refresh.}}
 
  MyRepository.Project.SetCurrentProject (1)
  {{APIComment|'Delete model #71 from project #1.}}
  MyRepository.Model.DeleteModel(71)
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Model.DeleteModel(71)

Latest revision as of 17:25, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Deletes an unused model from the current project. Throws an exception if the model is in use. Returns a Boolean value; when true, indicates a successful deletion.

Syntax

.Model.DeleteModel(ID)

Parameters

ID

Required. Integer. The ID number of the model to delete.


Example

This example assumes that an unused model with ID #71 exists in the first 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")
 
 'Delete model #71 from project #1. 
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Model.DeleteModel(71)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.DeleteModel&oldid=63281"