QPR Knowledge Base 2015.1

DeleteObject

DeleteObject

Previous topic Next topic No directory for this topic  

DeleteObject

Previous topic Next topic Topic directory requires JavaScript Mail us feedback on this topic!  

Revision history:

Introduced in QPR 7.6.1 SP2

 

Deletes the object supplied as a parameter from the model and removes all references/links to the object. The objects that can be removed are of type information item, alert, or linked element.

 

Synopsis:

 

SCModel.DeleteObject(ObjectId)

 

Parameters:

 

ObjectId: Integer. ID of object which is to be deleted.

 

Required Rights:

 

Administrator or Model Administrator rights to the SCModel.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_NOT_AUTHENTICATED

RV_SUCCESS

RV_MODEL_NOT_OPEN

RV_NO_RIGHTS

RV_OBJECT_NOT_FOUND

RV_INVALID_OBJECT_TYPE

RV_UNKNOWN_ERROR

 

Example Procedure:

 

iRet = SCModel.DeleteObject(iInfoItemId)