Repository.Model.IsModelUsed: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 18: Line 18:
  {{APIComment|'Get the list of models in the connected repository.}}
  {{APIComment|'Get the list of models in the connected repository.}}
   Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
   Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
   ListOfModels = MyRepository.GetAllModelsInfo()
   ListOfModels = MyRepository.Model.GetAllModelsInfo()
    
    
  {{APIComment|'Retrieve the model with ID = 20.}}
  {{APIComment|'Retrieve the model with ID = 20.}}
   Dim AModel as cModel
   Dim AModel as cModel
   AModel = MyRepository.GetModel(20)
   AModel = MyRepository.Model.GetModel(20)
    
    
  {{APIComment|'Change the model's name.}}
  {{APIComment|'Change the model's name.}}
Line 29: Line 29:
  {{APIComment|'Update the model in the repository.}}
  {{APIComment|'Update the model in the repository.}}
   Dim SuccessUpdateModel As Boolean
   Dim SuccessUpdateModel As Boolean
   SuccessUpdateModel = MyRepository.UpdateModel(20)
   SuccessUpdateModel = MyRepository.Model.UpdateModel(20)
   
   
  {{APIComment|'Check to see if Model 20 is being used.}}
  {{APIComment|'Check to see if Model 20 is being used.}}
   Dim SucessIsModelUsed As Boolean
   Dim SucessIsModelUsed As Boolean
   SucessIsModelUsed = MyRepository.IsModelUsed (20)
   SucessIsModelUsed = MyRepository.Model.IsModelUsed (20)
      
      
  {{APIComment|'Disconnect from the repository.}}
  {{APIComment|'Disconnect from the repository.}}
   MyRepository.DisconnectFromRepository
   MyRepository.DisconnectFromRepository

Revision as of 16:29, 22 May 2015


Version 10 Only- Checks if the model is currently in use by other items.

Syntax

IsModelUsed(ByVal ID As Integer) As Boolean

Parameters

ID: The ID that will have its use checked.

Usage Example

 'Declare a new repository connection object. 
 Dim MyRepository As New Repository
 
 'Connect to the Synthesis repository. 
 Dim Success As Boolean = False
 Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 'Get the list of models in the connected repository. 
 Dim ListOfModels() As NameIdPair
 ListOfModels = MyRepository.Model.GetAllModelsInfo()
 
 'Retrieve the model with ID = 20. 
 Dim AModel as cModel
 AModel = MyRepository.Model.GetModel(20)
 
 'Change the model's name. 
 AModel.Name = "New Name"
  
 'Update the model in the repository. 
 Dim SuccessUpdateModel As Boolean
 SuccessUpdateModel = MyRepository.Model.UpdateModel(20)

 'Check to see if Model 20 is being used. 
 Dim SucessIsModelUsed As Boolean
 SucessIsModelUsed = MyRepository.Model.IsModelUsed (20)
   
 'Disconnect from the repository. 
 MyRepository.DisconnectFromRepository