All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMSaveAction
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMSaveAction
Usage: you can freely reimplement this interface.
interface CATIPDMSaveAction
Method Index
- o
PostErrorMsg(CATUnicodeString&)
- Report an error to the user If called from BeforeSaveDialog, OnOK, BeforeStartingSave it interupts the save, similarly to this function returning a failure
- o
PostWarningMsg(CATUnicodeString&)
- Report a warning to the user, but does not interupt the save.
Methods
o PostErrorMsg
-
Report an error to the user If called from BeforeSaveDialog, OnOK, BeforeStartingSave it interupts the save, similarly to this function returning a failure
- Parameters:
-
- iMsg
- Message to be reported to the user
- Returns:
- S_OK: Success
E_FAIL: Failure
o PostWarningMsg
-
Report a warning to the user, but does not interupt the save. To be noticed that warning issued from BeforeSaveDialog, OnOK
- are reported to the user after it presses OnOK (even if the warning was coming from BeforeSaveDialog)
- stop the user in the save command: The work flow is the following
1./ The user Selects the OK button on the save pannel
2./ He Gets the pannel with the warning
3./ He has to destroy the reporting pannel
4./ He is back then to the save pannel for potential edition and has to OK again in order to save. This to let him
take potential corrective actions that he has been warned about
This means certain precautions should be taken when calling PostWarningMsg fom OnOK, to not end up with an endless loop..
- Parameters:
-
- iMsg
- Message to be reported to the user
- Returns:
- S_OK: Success
E_FAIL: Failure
This object is included in the file: CATIPDMSaveAction.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf