Ricoh InfoPrint Manager for AIX, Manual

Page: 89 / 418

parameter to save information across calls (for example, pointers to work
areas). The 16-byte work area is aligned on a full word boundary and is
initialized to binary zeros before the first call. The user-written exit program
must provide the code required to manage this work area.
pfattr (Bytes 5–8)
A pointer to the print file attribute data structure. See “Attributes of the
line-data input file” on page 80 for more information about the format of this
data structure and the information it contains.
record (Bytes 9–12)
A pointer to the first byte of the input record including the carriage control
character. The record is located in a buffer that is located in storage allocated
by the line-data transform but the exit program is allowed to modify the input
record.
in_CCSID (Bytes 13-14)
The value from the INPCCSID parameter on the line2afp command.
out_CCSID (Bytes 15-16)
The value from the OUTCCSID parameter on the line2afp command.
recordln (Bytes 17–18)
Specifies the number of bytes (length) of the input record. If the input record is
modified, this parameter must also be updated to reflect the actual length of
the record. If
recordln is 0 when the exit program returns, line2afp will
terminate with a return code of 99.
reserved2 (Bytes 19–20)
These bytes are reserved for future use.
request (Byte 21)
Specifies how the line-data transform processes the record. On entry to the exit
program, this parameter is X'00'. When the exit program returns control to
line-data transform, this parameter must have the value X'00', X'01', or X'02',
where:
X'00' Specifies that the line-data transform should process the record.
X'01' Specifies that the line-data transform should not process the record.
X'02'
Specifies that the line-data transform should process the record and
then return control to the exit program to allow it to insert the next
record. The exit program can set this value to save the current record,
insert a record, and then supply the saved record at the next call. After
the exit inserts the last record, the exit program must reset the
request
byte to X'00'.
A value of X'00' on entry to the exit program specifies that the record be
processed. If you want to ignore the record, change the
request byte value to
X'01'. If you want the record to be processed and you want to insert an
additional record, change the
request byte value to X'02'. Any value greater
than X'02' is interpreted as X'00', and the exit processes the record.
Note: Only one record can reside in the buffer at any time.
eof (Byte 22)
An end-of-file ( eof ) indicator. This indicator is a one-byte character code that
specifies whether an eof condition has been encountered.
When eof is signaled ( eof value=‘Y’), the last record has already been
presented to the input exit, and the input file has been closed. The pointer
Chapter 6. User-exit programs (PSF, Generalized Fax, and Email DSS only)
75