Copyright © Cloud Software Group, Inc. All Rights Reserved

$PRINTFIELD

Writes the specified string into the current printline. (C)

Invocation

CALL $PRINTFIELD(string, pos, length, fill, just)

 

string	The string to be inserted. Its syntax can be C (fixed-length character string), V (variable-length character string), or W (double-byte character).
pos	An integer specifying the position at which to insert the string. Its syntax is B (binary) with length 2.
length	An integer specifying the length to which to pad the string. Its syntax is B with length 2.
fill	A printable string specifying the character with which to pad the string. Its syntax is C with length 1.
just	One of: LEFT or L – Specifies that the string should be left justified. RIGHT or R – Specifies that the string should be right justified. CENTER, CENTRE, or C – Specifies that the string should be centered. Its syntax is C with length 8.

Usage Notes

•	The print arguments must be previously set with a call to $SETPRINT or $RESETPRINT before a call to $PRINTFIELD.

•	Use $PUTLINE to output the printline.

Exceptions

 

RANGERROR	This exception is raised for one of the following reasons: pos – is less than or equal to zero. length – is less than zero. fill – is not a printable character. just – is not one of C, CENTER, CENTRE, L, LEFT, R, or RIGHT.
ROUTINEFAIL	$PRINTFIELD is not preceded by a call to $RESETPRINT or $SETPRINT.
STRINGSIZE	The length of text is greater than the print width (where width is the page width set by $RESETPRINT or $SETPRINT).

Example

The following rule prints a string to the message log:

---

 

PRINTFIELD_1;

_ LOCAL SOURCE_STRING;

     _ ------------------------------------------------------------+-----------

_ ------------------------------------------------------------+-----------

_ CALL $SETPRINT(10, 70, 1, 'SCR', 'N'); | 1

_ SOURCE_STRING = 'THIS IS THE SOURCE STRING'; | 2

_ CALL $PRINTFIELD(SOURCE_STRING, 1, 70, '*', 'L'); | 3

_ CALL $PRINTFIELD('OUTPUT', 13, 6, '', 'C'); | 3

_ CALL $PUTLINE; | 4

_ ------------------------------------------------------------------------

---

 

Displayed Output for the PRINTFIELD_1 Rule

Using PF2 after executing this rule displays the following screen. The second call to $PRINTFIELD replaced the word SOURCE from SOURCE_STRING with the word OUTPUT.

---

 

----------------------- INFORMATIONAL MESSAGE LOG --------------------

COMMAND ===> SCROLL ===> P

 

------------------------------ NEW PAGE ------------------------------

 

                                                                     Page 1

THIS IS THE OUTPUT STRING*********************************************

---

 

Copyright © Cloud Software Group, Inc. All Rights Reserved