All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppDeleteCheck

System.IUnknown
  |
  +---CATISchAppDeleteCheck
 

Usage: you can freely reimplement this interface.


interface CATISchAppDeleteCheck

Interface to enable delete checking behavior of Schematic component objects.
Role: To provide approval information as to how the object can can or should be deleted.


Method Index


o AppGetDeleteWarning(CATUnicodeString*,CATUnicodeString*)
Returns the caption and message text to be used as a warning for the delete operation.
o AppOkToDeleteWithoutWarning(CATBoolean*)
Reports if a warning message should be issued before deleting the object.

Methods


o AppGetDeleteWarning
public virtual HRESULT AppGetDeleteWarning(CATUnicodeString* oCaption,
CATUnicodeString* oMessage) = 0
Returns the caption and message text to be used as a warning for the delete operation.
Parameters:
oCaption
Pointer to a CATUnicode string used for the caption of the message box.
oMessage
Pointer to a CATUnicode string used as the warning message.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOkToDeleteWithoutWarning
public virtual HRESULT AppOkToDeleteWithoutWarning(CATBoolean* oOk) = 0
Reports if a warning message should be issued before deleting the object.
Example:A Logical Line with members cannot be deleted without complications. Its members must also be deleted for model integrity. A Logical Line with members would return FALSE in this case.
Parameters:
oOK
Pointer to the CATBoolean to receive the ok.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppDeleteCheck.h

Copyright © 2003, Dassault Systèmes. All rights reserved.