ICape
Writes a message to the terminal.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(1)]
void PopUpMessage(
string message
)VB
<DispIdAttribute(1)>
Sub PopUpMessage (
message As String
)Parameters
- message String
- The text to be displayed.
Remarks
Write a string to the terminal.
This method is called when a message needs to be brought to the user’s attention. The implementation should ensure that the string is written out to a dialogue box or to a message list that the user can easily see.
A priori this message has to be displayed as soon as possible to the user.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |