DOC1 Programmer's Guide

Programming PCE
call userexit
Function Calls an external program via the user exit feature.
Syntax
[let result = ] call userexit id [with parameter in cell...];
Parameters result a variable to accept a return value
id
text; indicates a user exit identifier
parameter a variable or array element containing text or a page of output datastream
cell
integer; indicates a PCE memory cell.
Effects
The user defined program specified by the identifier id in the User Exit Control File assigned
in the PCE initialization file is executed. The program can be passed one or more optional
parameters values using the defined PCE memory cell.
Comments
If a value is returned by the user exit program will be stored in result if this is coded.
User exits of type PRINTSTREAM should return a self-contained segment of output
datastream. This can be included within an existing page using the insert object command.
Parameters can only contain a STRING or PAGE data types; NUMBER and DATE data
types are not supported. The PCE memory cell for the parameter must be in the range 9900–
9998 and must match the appropriate number specified in the DOC1 Engine Data Exchange
API function being used with the user program. The result value, if used, will always be of
type STRING.
Refer to the “User Exits” on page 191 in this guide for more information about the
communication process between PCE and user programs, returning AFP image objects and
coding the User Exit Control File.
Example ...
let = "Customer_Name";
let = "Customer_Number";
call userexit "WriteName" with in 9900;
let = call userexit "GetAddress" with in 9901;
let = substring 2 5;
change DIJelement
Function
Syntax
Updates the value of an element of an entry in a DOC1 Interchange Journal (DIJ).
change DIJelement
{Name|AddrLine1...AddrLine6|City|Region|PostalCode|Country|Phone|
NumberOfPages|SkippedPages} value to value in dijRecord ;
Parameters value text; the value with which the DIJ element is updated
dijRecord a variable containing a DIJ record.
34