BaseContext :: message - Display message
The function displays a message constructed from a message resource or from the text passed to the function. Depending on the environment, the message is shown on a console, in an output area of an GUI application or in a message box.
When the context handle does not refer to a valid context instance the function throws an exception.
In case of decision messages, the function returns true, when the answer is OK and false otherwise (NO, Cancel).
The value is true when the function was executed successfully. Otherwise the value is set to false.
Implementation overview
- Display message for last error
BaseContext :: message ( ) - Display message for message resource
BaseContext :: message ( iMessageNumber, sParameter1, sParameter2, sParameter3 ) - Display message text
BaseContext :: message ( sString ) - Display message text with title
BaseContext :: message ( sString, sTitle, eMessageTypes )
Implementation details
-
Display message for last error
bool BaseContext :: message ( )
When an error has been set, the function displays text and additional information for the last error. When no error is set, nothing will be displayed.
to list
-
Display message for message resource
bool BaseContext :: message ( int32 iMessageNumber, odaba::String &sParameter1, odaba::String &sParameter2, odaba::String &sParameter3 )
In order to provide extended message support as multilingual messages or message explanations, message resources can be defined in an error class of a project. Message resources are identified by a message number (iMessageNumber) and may contain placeholders for message variables, which will be replaced by sParamater1, sParamater2 and sParamater3.
- iMessageNumber
- Message number
The message number passed refers be an error/message definition the resource database.
- sParameter1 - String parameter
- sParameter2 - String parameter
- sParameter3 - String parameter
to list
- iMessageNumber
- Message number
-
Display message text
bool BaseContext :: message ( odaba::String &sString )
The text as being passed to the function (sString) will be displayed in the message (output) area.
- sString - String value
to list
-
Display message text with title
bool BaseContext :: message ( odaba::String &sString, odaba::String &sTitle, odaba::MessageTypes eMessageTypes )
The text as being passed to the function (sString) will be displayed in the message box or output area. In case of question or decision messages, the function returns true, when the OK button has clicked.
- sString - String value
- sTitle - - internal feature (not documented)
- eMessageTypes - - internal feature (not documented)
to list