Note command

The Note command can be used to by a Formatting user exit to print a line of text.

Figure 1. Syntax

Parameters

'text'

Specifies the text to be printed, enclosed in apostrophes. Either single quotes (') or double quotes (") are permitted, as long as the same type is used as both the first and the last character.

Any quotes within the text, of the same type as used to enclose the string, must be specified twice. For example, to print

It isn't there

specify the text as either

"It isn't there"

'It isn''t there'

If no text is specified, then no data is printed. However, any blank lines specified using the SPACE parameter are still written.

SPACE SPACE(count)

Specifies the number of blank lines to be written ahead of the next text line.

If the SPACE parameter is specified without count, then it defaults to 1.

CAPS

Specifies that text is written in all uppercase characters.

ASIS

Specifies that text is written "as is" without any uppercasing being performed.

NOSPACE

Specifies that no blank lines are written ahead of the next text line. This value is the default.

If a parameter is specified multiple times, then only the last specification takes effect.

Return codes

The Note command provides the following return codes:

0: Command completed successfully.
12: Command syntax error. An explanation of the error is written to the IDITRACE DDname.

Example

Figure 2. Note command example

/* REXX */

"NOTE 'This is a simple note.'"
"NOTE 'This note follows the previous without any blank lines inserted.'"
"NOTE 'This note has 2 blank lines ahead of it.' SPACE(2)"

The above example produces the following output:

This is a simple note.
This note follows the previous without any blank lines inserted.


This note has 2 blank lines ahead of it.