Message

Writes a message onto the console and to the protocol file.

Child elements

Element, Value

Parent elements

AtPageCreation, AtPageShipout, Case, Contents, ForAll, Function, Layout, Loop, Otherwise, Record, SavePages, Section, Table, Tr, Until, While

Attributes

error (optional)

Generate an error besides writing the message.

• yes: Report an error.
• no: Do not report an error (default).

errorcode (number, optional, since version 2.3.69)

If an error is raised, use this code on exit. Defaults to 1. Negative values are reserved for system purpose.

exit (optional, since version 3.1.17)

Stop the data processing after this message?

• no: The speedata Publisher continues with the PDF creation (default).
• yes: The speedata Publisher stops processing the data and writes the PDF file with the pages processed so far. The current page is written as well, even if it is still empty. Useful for checking the first pages of a large document. Before version 5.9.6 the PDF file was left unfinished.

select (XPath expression, optional)

Contents of the message. You can alternatively specify the message by the child elements Value.

Example

<Message select="concat('Price: ',@price)" error="no"/>

<Record element="data">
  <Message>
    <Value>Attribute price: </Value>
    <Value select="@price"/>
  </Message>
</Record>

<!-- only typeset the first 100 pages of a large document -->
<Switch>
  <Case test="sd:current-page() = 100">
    <Message select="'Stopping after page 100'" exit="yes"/>
  </Case>
</Switch>
<ClearPage/>