InterForm Manual - System & Method

Calling a User Exit Program with the extracted spool pages
182 User’s Manual for InterForm400 ®
Change Split Definition SPL310D
Split definition name . : IF400ONLY
Description . . . . . . : Sort IF400 Pages
Split detail description : IF400 ONLY
User exit program
Program name . . . . . . *NONE_____ *NONE, name
Library . . . . . . . __________ name
F3=Exit F12=Cancel
This screen can be used to call a user exit program, that inserts information in the spool entry
resulting from the split.
®
InterForm400 will call the program with a set of parameters consisting of up to either 5 or 10
lines each containing a field of up to 30 positions. The amount of exit parameters depends on
the format: 01 equals 5 exit parameters, 02 equals 10 exit parameters, 03 equals the 10 exit
parameters as well as 300 character parameter, that contains all attributes of the original
spooled file.
For additional information on return parameters look into the sample programs, SPLEXIT,
SPLEXIT02, SPLEXIT03 and SPLEXIT04 in the source file APISRC in library APF3812.
Please notice that the spooled file attribute parameters are all RETURN parameters, that are
empty when the program is called.
These various programs differs in these manners:
SPLEXIT (Format=1). This was the first (simple) kind of split exit program supported.
The program get up to 5 texts from the spooled file and returns up to 10 texts
into the new splitted spooled file.
SPLEXIT02 (Format=2). Same as SPLEXIT with the only difference, that you here can get
up to 10 texts from the spooled file.
SPLEXIT03 (Format=3). Same as SPLEXIT02 with the only difference, that you here get a
complete data structure with ALL the information of the spooled file that
triggered the split definition.
SPLEXIT04 (Format=4). This is a unicode exit program. This is needed if you want to use
a split definition to change the contents of a unicode spooled file. Please
notice that all text returned from the program are expected to be in unicode,
where the other split exit programs above run in the codepage of the spooled
file (or AFC job if not defined).
One example could be a customer ID which the user exit program uses to look up a fax
®
number in a database, which is returned to InterForm400 to insert in the spool entry resulting
from the split.