This function outputs all messages queued for a specified message group or all message groups in HTML. If no prior output has been sent for the current Web request, an entire HTML page is generated with appropriate Content-type header, head, and body sections. Otherwise, the messages are output in the format of an HTML unnumbered bulleted list. The returned value is the number of messages output.
Location
web\method\message.i
Parameters
INPUT p_option AS CHARACTER
Specifies the messages to output. The valid values are as follows:
"page" — Output all queued messages as a single HTML page.
"all" — Output all queued messages, but no HTML title and H1 are output. This option is suitable for dumping all messages out from an application.
"group" — Output just the messages in a single group as specified with queue-message function.
INPUT p_grp AS CHARACTER
If using the "group" setting for p_option, the name of message group from which to output messages. If the Unknown value (?) is specified, outputs all messages.
INPUT p_message AS CHARACTER
An optional message heading. With the "page" option, this text is displayed in the HTML title and H1 sections. With the "all" option, or "group" option, the text is displayed before the messages are output as a heading.
Returns
INTEGER
Notes
All queued messages are output after the Web object specified in the URL returns. As such, messages do not remain queued between requests.
If there are no messages to be output matching the requested input parameters, then no heading or other output is generated so it is not necessary to see if there are any messages to output before calling this function.
Examples
See the PrintVars procedure in web\support\printval.p.
"page" — Output all queued messages as a single HTML page.