ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/XDOCHAND.htm

3056 lines
86 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Document Handling Exit Program</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records ========================================== -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited October 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Document Handling Exit Program</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Document name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(12)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Folder name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(63)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Document type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Function</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(26)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Function-specific information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Exit processing indicator</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;QSYSINC Member Name: EOGDOCH<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Document Handling program allows other applications to be called in
place of or in addition to the OfficeVision word processor. Requests are sent
to the exit program. The exit program can choose to process the request or
return it to the OfficeVision program for processing.</p>
<p>OfficeVision application enabler support assists users in integrating other
office applications into OfficeVision. This is accomplished by creating command
interfaces that define the applications to OfficeVision in terms of document
types. Applications created this way can support the following functions:</p>
<p><strong><a name="TBLREGIST">Table 1. APIs Used to Register User Exit
Applications</a></strong></p>
<table border width="80%">
<tr>
<th align="left" valign="top">Function</th>
<th align="left" valign="top">API Used for Registration</th>
<th align="left" valign="top">Exit Point Name and Exit Point Format Name</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">ADDRESSING</td>
<td align="left" valign="top" width="25%">Add Exit Program API</td>
<td align="left" valign="top" width="60%">QIBM_QOE_OV_USR_SND, DOCI0900</td>
</tr>
<tr>
<td align="left" valign="top">ADDRCANCEL</td>
<td align="left" valign="top">Add Exit Program API</td>
<td align="left" valign="top">QIBM_QOE_OV_USR_SND, DOCI0900</td>
</tr>
<tr>
<td align="left" valign="top">CREATE</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">EDIT</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">FILLFORM</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MAILEDIT</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MAILVIEW</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MAILFWD</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MAILREPLY</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MERGE</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">MERGEOPTS</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">PAGINATE</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">PRINT</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">PRINTOPTS</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">SEND</td>
<td align="left" valign="top">Add Exit Program API</td>
<td align="left" valign="top">QIBM_QOE_OV_USR_SND, DOCI0900</td>
</tr>
<tr>
<td align="left" valign="top">SPELLCHECK</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">VIEW</td>
<td align="left" valign="top">QOGCHGOE</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="LEFT" valign="TOP" colspan="3"><strong>Note:</strong> For
performance improvements, a local copy of the API information is cached on the
first usage by a job. The cached API information is then available for reuse by
the executing job. (For example, when a job needs information about a
registered user exit program, the information is cached.) Therefore, the
changes to the API may not take effect until after the jobs with the cached
information are terminated. This means that a user may need to sign off then
sign on again before the API changes become effective.
<p>The sign off process is an example of a job termination. The sign on process
starts a new job.</p>
</td>
</tr>
</table>
<br>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Document name</strong></dt>
<dd>INPUT; CHAR(12)
<p>The name of the document on which the function is performed.</p>
</dd>
<dt><strong>Folder name</strong></dt>
<dd>INPUT; CHAR(63)
<p>The folder in which the document is located.</p>
</dd>
<dt><strong>Document type</strong></dt>
<dd>INPUT; BINARY(4)
<p>The DIA document type ID. You can display a list of document types defined
with the Work with Document Types (WRKDOCTYP) command. The value must be from 1
to 65535.</p>
</dd>
<dt><strong>Function</strong></dt>
<dd>INPUT; CHAR(26)
<p>The first 10 characters is the type of operation that the user is requesting
for this document. The next 16 characters contain the address of the current
work on behalf of user. If there is no work on behalf of user, it will contain
spaces.</p>
<blockquote>
<p>Refer to the <a href="#HDRI01">DOCI0100 Format</a> for print function
requests.</p>
<p>Refer to the <a href="#HDRI02">DOCI0200 Format</a> for merge function
requests.</p>
<p>Refer to the <a href="#HDRI03">DOCI0300 Format</a> for spell function
requests.</p>
<p>Refer to the <a href="#HDRI04">DOCI0400 Format</a> for mail function
requests.</p>
<p>Refer to the <a href="#HDRI05">DOCI0500 Format</a> for edit function
requests.</p>
<p>Refer to the <a href="#HDRI06">DOCI0600 Format</a> for create function
requests.</p>
<p>Refer to the <a href="#HDRI07">DOCI0700 Format</a> for fill form function
requests.</p>
<p>Refer to the <a href="#HDRI08">DOCI0800 Format</a> for mail view function
requests.</p>
<p>Refer to the <a href="#HDRI09">DOCI0900 Format</a> for send, addressing, and
cancel user application addressing function requests.</p>
</blockquote>
</dd>
<dt><strong>Function-specific information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Additional input that varies by function. See <a href="#TBLDHFUNCT">Table
2</a> for more detailed information.</p>
<p><strong>Note:</strong> Function-specific information that is not specified
and for which there is no value stored in the document will be passed to the
exit program as blanks.</p>
</dd>
<dt><strong>Exit processing indicator</strong></dt>
<dd>OUTPUT; CHAR(4)
<p><a name="SPTEXIND"></a> The additional processing that the IBM programs
should perform on return from the document handling program. Any code returned,
when the function requested does not support it, will be treated as a return
code of 0000.</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>0000</em></td>
<td valign="top">No additional processing required for this request. (Processed
like the enter key from the exit.)</td>
</tr>
<tr>
<td valign="top"><em>0001</em></td>
<td valign="top">Request has been processed, and the user requested to return.
The IBM programs process as if F12 were pressed.</td>
</tr>
<tr>
<td valign="top"><em>0002</em></td>
<td valign="top">Request has been processed, and the user requested to return.
The IBM programs process as if F3 were pressed.</td>
</tr>
<tr>
<td valign="top"><em>0007</em></td>
<td valign="top">Request OfficeVision to delete the document from the mail log
(only valid on VIEWMAIL requests).</td>
</tr>
<tr>
<td valign="top"><em>0008</em></td>
<td valign="top">Request has been processed and the user requested that the
item be sent. Only the MailEdit, MailForward, MailReply, Addressing, and
Addcancel functions are valid.</td>
</tr>
<tr>
<td valign="top"><em>0010</em></td>
<td valign="top">The OfficeVision program will process the requester as if the
user exit had not been called.
<ul>
<li>For the user application send exit program (ADDRESSING, ADDRCANCEL, and
SEND functions), additional processing will occur.<br>
<br>
<ul>
<li>If a higher numbered registered user exit program has been defined, that
exit program will be called to process the request as if the previous user exit
program had not been called.<br>
<br>
</li>
<li>If 0010 is returned from the highest numbered registered exit program,
OfficeVision will treat the request as an exit processing indicator of
0000.<br>
<br>
</li>
</ul>
</li>
<li>Considerations for a mail document:
<p>When working with a mail document, a copy of the original mail document is
made. This is done to preserve the integrity of the original mailed document.
This copied document is the document that is passed to the application user
exit program.</p>
<p>If a user exit program decides to use the 0010 exit processing indicator on
exit (that is, let OfficeVision handle this document), then the application
enabler will check to see if a higher numbered user exit program is registered.
If so, this second user exit program will get passed to the copied document
(this is the copied document that the first user exit program had access to and
had the opportunity to modify or transform the data stream content).</p>
<p>Now if the second user exit program decides to use the 0010 exit processing
indicator on exit (and this is the highest number user exit program), the
application enabler will return to mail with the request to let OfficeVision
process the document.</p>
<p>It is the responsibility of the user exit programs to maintain the integrity
of the copied document. It is possible that one of the user exit programs may
have modified the document before the user exit program returns (for example,
the user exit program had the opportunity to modify any part of the document or
perhaps it may have transformed it to another data stream content).</p>
<p>The customer installation is responsible for maintaining the integrity of
this copied document. If it is important that the exact document is kept upon
return from the user exit program, perhaps the user exit program must make a
copy before it calls the application program to process the document. It is the
responsibility of the user exit program to handle deleting the copied document
that it created.</p>
</li>
</ul>
</td>
</tr>
<tr>
<td valign="top"><em>0011</em></td>
<td valign="top">User is requesting that the document be filed locally. If any
function other than MailView is used, it is treated as a 0000 return.</td>
</tr>
<tr>
<td valign="top"><em>0012</em></td>
<td valign="top">User is requesting that the document be filed remotely. If any
function other than MailView is used, it is treated as a 0000 return.</td>
</tr>
<tr>
<td valign="top"><em>0013</em></td>
<td valign="top">User is requesting that the document be forwarded. If any
function other than MailView is used, it is treated as a 0000 return.</td>
</tr>
<tr>
<td valign="top"><em>0014</em></td>
<td valign="top">User is requesting a reply to the document. If any function
other than MailView is used, it is treated as a 0000 return.</td>
</tr>
</table>
</dd>
</dl>
<p><a href="#TBLDHFUNCT">Table 2</a> shows when the exit program will be called
for each of the document functions.</p>
<p><strong><a name="TBLDHFUNCT">Table 2. Document Handling Function
Requests</a></strong></p>
<table border width="80%">
<tr>
<th align="left" valign="top">Function</th>
<th align="left" valign="top">Description</th>
<th align="left" valign="top">Where Called From</th>
</tr>
<tr>
<td align="left" valign="top" width="20%">'ADDRESSING'</td>
<td align="left" valign="top" width="20%">User application addressing(DOCI0900
format)</td>
<td align="left" valign="top" width="60%">
<ul>
<li><em>Send Note</em> display; F15<br>
<br>
</li>
<li><em>Send Document</em> display; F15<br>
<br>
</li>
<li><em>Send Form</em> display; F15<br>
<br>
</li>
<li><em>Forward a Mail Item</em> display; F15<br>
<br>
</li>
<li><em>Reply to a Mail Item</em> display; F15<br>
<br>
</li>
<li>SNDDOC command; F15</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'ADDRCANCEL'</td>
<td align="LEFT" valign="TOP">Cancel user application addressing (DOCI0900
format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li><em>Send Note</em> display; F12; F3<br>
<br>
</li>
<li><em>Send Document</em> display; F12; F3<br>
<br>
</li>
<li><em>Send Form</em> display; F12; F3<br>
<br>
</li>
<li><em>Forward a Mail Item</em> display; F12; F3<br>
<br>
</li>
<li><em>Reply to a Mail Item</em> display; F12; F3<br>
<br>
</li>
<li>SNDDOC command; F12; F3</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'CREATE'</td>
<td align="LEFT" valign="TOP">Create document (DOCI0600 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>CRTDOC command<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 1</li>
</ul>
<p><strong>Note:</strong> The exit program is called after the Enter key or F10
is pressed on the Create Document Details display, when details are used.</p>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'VIEW'</td>
<td align="LEFT" valign="TOP">View document (No function specific format
information)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>DSPDOC command<br>
<br>
</li>
<li>MERGE request with DSPOPT(*VIEW)<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 5<br>
<br>
</li>
<li><em>Work with Documents in a List</em> display; option 5</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'EDIT'</td>
<td align="LEFT" valign="TOP">Edit document and revise a copy of a mail item
(DOCI0500 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>EDTDOC command<br>
<br>
</li>
<li>MERGE request with DSPOPT(*EDIT)<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 2<br>
<br>
</li>
<li><em>Work with Documents in a List</em> display; option 2<br>
<br>
</li>
<li><em>Work with Mail</em> display; option 2</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'FILLFORM'</td>
<td align="LEFT" valign="TOP">Fill Form Document (complete a form using the
fill form editor of OfficeVision for AS/400) (DOCI0700 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>FILLFORM command<br>
<br>
</li>
<li>MRGDOC command; DSPOPT is *FILLFORM<br>
<br>
</li>
<li><em>Work with Documents in a List</em> display; option 15</li>
</ul>
<p><strong>Note:</strong> The exit program is called after the Enter key or F10
is pressed on the Create Document Details display, when details are used.</p>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MAILVIEW'</td>
<td align="LEFT" valign="TOP">View mail item (DOCI0800 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li><em>Work with Mail</em> display; option 5</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MAILEDIT'</td>
<td align="LEFT" valign="TOP">Create a note (DOCI0400 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li><em>OfficeVision</em> main menu; option 4</li>
</ul>
<p><strong>Note:</strong> The exit program is called after F6 (Type Note) is
pressed on the <em>Send Note</em> display.</p>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MAILFWD'</td>
<td align="LEFT" valign="TOP">Forward a note (DOCI0400 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li><em>Work with Mail</em> display; option 10</li>
</ul>
<p><strong>Note:</strong> The exit program is called after F6 (Type Note) is
pressed on the <em>Forward Mail</em> display.</p>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MAILREPLY'</td>
<td align="LEFT" valign="TOP">Reply to a note (DOCI0400 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li><em>Work with Mail</em> display; option 11</li>
</ul>
<p><strong>Note:</strong> The exit program is called after F6 (Type Note) is
pressed on the <em>Reply to Mail</em> display.</p>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MERGE'</td>
<td align="LEFT" valign="TOP">Merge document (DOCI0200 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>MRGDOC command; display merge options is *NO</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'MERGEOPTS'</td>
<td align="LEFT" valign="TOP">Merge document with options (DOCI0200
format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>MRGDOC command; display merge options is *YES</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'PRINT'</td>
<td align="LEFT" valign="TOP">Print request (DOCI0100 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>PRTDOC command; display print options is *NO<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 6<br>
<br>
</li>
<li><em>Work with Documents in a List</em> display; option 6<br>
<br>
</li>
<li><em>Work with Mail</em> display; option 6</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'PRINTOPTS'</td>
<td align="LEFT" valign="TOP">Print with options (DOCI0100 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>PRTDOC command; Display print options is *YES<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 9<br>
<br>
</li>
<li><em>Work with Documents in a List</em> display; option 9<br>
<br>
</li>
<li><em>Work with Mail</em> display; option 9</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'PAGINATE'</td>
<td align="LEFT" valign="TOP">Paginate document (DOCI0100 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>PAGDOC command<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 13</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'SEND'</td>
<td align="LEFT" valign="TOP">User application send (DOCI0900 format)</td>
<td align="LEFT" valign="TOP">If F15 processing was previously preformed:
<ul>
<li><em>Send Note</em> display; F10<br>
<br>
</li>
<li><em>Send Document</em> display; F10<br>
<br>
</li>
<li><em>Send Form</em> display; F10<br>
<br>
</li>
<li><em>Forward a Mail Item</em> display; F10<br>
<br>
</li>
<li><em>Reply to a Mail Item</em> display; F10<br>
<br>
</li>
<li>SNDDOC command; F10<br>
<br>
</li>
<li>F10 or F11 from an edit session</li>
</ul>
</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">'SPELLCHECK'</td>
<td align="LEFT" valign="TOP">Check the spelling accuracy or grade level of a
document (DOCI0300 format)</td>
<td align="LEFT" valign="TOP">
<ul>
<li>CHKDOC command<br>
<br>
</li>
<li><em>Work with Documents in Folders</em> display; option 11</li>
</ul>
</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI01">DOCI0100 Format</a></h3>
<p>This is the function-specific information for PRINT and PRINTOPTS requests.
This format is filled out the same as it would have looked if the OfficeVision
program were to process the request. This format merges the parameters
specified on the PRTDOC command with the print options record. The <em>
Field</em> column describes the associated PRTDOC parameter for each
format.</p>
<!-- The <cite>Office Services Concepts and Programmer's Guide</cite>, SH21-0703, has
more information about the meaning of the parameters. -->
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> have more detailed
information about the fields for this format.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(2)</td>
<td align="LEFT" valign="TOP" width="60%">Number of copies to print</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">2</td>
<td align="CENTER" valign="TOP">2</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Output device</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">3</td>
<td align="CENTER" valign="TOP">3</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Printer device name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">13</td>
<td align="CENTER" valign="TOP">D</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Output queue name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">23</td>
<td align="CENTER" valign="TOP">17</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Output queue library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">33</td>
<td align="CENTER" valign="TOP">21</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Output file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">43</td>
<td align="CENTER" valign="TOP">2B</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Form type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">53</td>
<td align="CENTER" valign="TOP">35</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Printer file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">63</td>
<td align="CENTER" valign="TOP">3F</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Printer file library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">73</td>
<td align="CENTER" valign="TOP">49</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Device file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">83</td>
<td align="CENTER" valign="TOP">53</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Device library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">93</td>
<td align="CENTER" valign="TOP">5D</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Device member name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">103</td>
<td align="CENTER" valign="TOP">67</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Delay printing</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">104</td>
<td align="CENTER" valign="TOP">68</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Draft spacing</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">105</td>
<td align="CENTER" valign="TOP">69</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print line numbers</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">106</td>
<td align="CENTER" valign="TOP">6A</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Resolve instructions</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">107</td>
<td align="CENTER" valign="TOP">6B</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Large print</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">108</td>
<td align="CENTER" valign="TOP">6C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Graphic character set</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">112</td>
<td align="CENTER" valign="TOP">70</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Code page</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">116</td>
<td align="CENTER" valign="TOP">74</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print separator page</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">117</td>
<td align="CENTER" valign="TOP">75</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Adjust line endings</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">118</td>
<td align="CENTER" valign="TOP">76</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Adjust page endings</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">119</td>
<td align="CENTER" valign="TOP">77</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Allow widow lines</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">120</td>
<td align="CENTER" valign="TOP">78</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Additional spaces to left</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">122</td>
<td align="CENTER" valign="TOP">7A</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print change symbols</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">123</td>
<td align="CENTER" valign="TOP">7B</td>
<td align="LEFT" valign="TOP">CHAR(5)</td>
<td align="LEFT" valign="TOP">Change symbols to print</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">128</td>
<td align="CENTER" valign="TOP">80</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print quality</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">129</td>
<td align="CENTER" valign="TOP">81</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Place on job queue</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">130</td>
<td align="CENTER" valign="TOP">82</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Send completion message</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">131</td>
<td align="CENTER" valign="TOP">83</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Job description name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">141</td>
<td align="CENTER" valign="TOP">8D</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Job description library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">151</td>
<td align="CENTER" valign="TOP">97</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Cancel on error</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">152</td>
<td align="CENTER" valign="TOP">98</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print error log</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">153</td>
<td align="CENTER" valign="TOP">99</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Error log form type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">163</td>
<td align="CENTER" valign="TOP">A3</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Clear error log after printing</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">164</td>
<td align="CENTER" valign="TOP">A4</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Save resolved output</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">165</td>
<td align="CENTER" valign="TOP">A5</td>
<td align="LEFT" valign="TOP">CHAR(12)</td>
<td align="LEFT" valign="TOP">Resolved output document</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">177</td>
<td align="CENTER" valign="TOP">B1</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Resolved output folder</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">240</td>
<td align="CENTER" valign="TOP">F0</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Multiple line report</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">241</td>
<td align="CENTER" valign="TOP">F1</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Print on both sides</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">242</td>
<td align="CENTER" valign="TOP">F2</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Automatic page binding</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">243</td>
<td align="CENTER" valign="TOP">F3</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Automatically shift margins to avoid truncating
text</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">244</td>
<td align="CENTER" valign="TOP">F4</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Renumber system page numbers</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">245</td>
<td align="CENTER" valign="TOP">F5</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 1</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">252</td>
<td align="CENTER" valign="TOP">FC</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 1</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">260</td>
<td align="CENTER" valign="TOP">104</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 2</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">267</td>
<td align="CENTER" valign="TOP">10B</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 2</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">275</td>
<td align="CENTER" valign="TOP">113</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 3</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">282</td>
<td align="CENTER" valign="TOP">11A</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 3</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">290</td>
<td align="CENTER" valign="TOP">122</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 4</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">297</td>
<td align="CENTER" valign="TOP">129</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 4</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">305</td>
<td align="CENTER" valign="TOP">131</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 5</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">312</td>
<td align="CENTER" valign="TOP">138</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 5</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">320</td>
<td align="CENTER" valign="TOP">140</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 6</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">327</td>
<td align="CENTER" valign="TOP">147</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 6</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">335</td>
<td align="CENTER" valign="TOP">14F</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Print from page 7</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">342</td>
<td align="CENTER" valign="TOP">156</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Print to page 7</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">350</td>
<td align="CENTER" valign="TOP">15E</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Document is a label document</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">351</td>
<td align="CENTER" valign="TOP">15F</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Number of labels</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">353</td>
<td align="CENTER" valign="TOP">161</td>
<td align="LEFT" valign="TOP">CHAR(3)</td>
<td align="LEFT" valign="TOP">Width of labels</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">356</td>
<td align="CENTER" valign="TOP">164</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Sheet-feed labels</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">357</td>
<td align="CENTER" valign="TOP">165</td>
<td align="LEFT" valign="TOP">CHAR(2)</td>
<td align="LEFT" valign="TOP">Number of rows per sheet</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">359</td>
<td align="CENTER" valign="TOP">167</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Merge type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">360</td>
<td align="CENTER" valign="TOP">168</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Query name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">370</td>
<td align="CENTER" valign="TOP">172</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Query library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">380</td>
<td align="CENTER" valign="TOP">17C</td>
<td align="LEFT" valign="TOP">CHAR(12)</td>
<td align="LEFT" valign="TOP">Data document name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">392</td>
<td align="CENTER" valign="TOP">188</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Data folder name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">455</td>
<td align="CENTER" valign="TOP">1C7</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">465</td>
<td align="CENTER" valign="TOP">1D1</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">475</td>
<td align="CENTER" valign="TOP">1DB</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file member name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI02">DOCI0200 Format</a></h3>
<p>This is the structure that is used by this exit program when the function is
for merge or merge with options. Note that the single-record merge is not
supported.</p>
<p>The merge situations where the user specified DSPOPT(*VIEW) or DSPOPT(*EDIT)
results in the exit program being called twice, once for the merge and then
once for the subsequent view or edit. The <em>Field</em> column describes the
associated MRGDOC parameter for each field.</p>
<!-- The <cite>Office Services Concepts and Programmer's Guide</cite>, SH21-0703, has
more information about the meaning of the parameters. -->
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> have more detailed
information about the fields for this format.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(12)</td>
<td align="LEFT" valign="TOP" width="60%">To document name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">To folder name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">75</td>
<td align="CENTER" valign="TOP">4B</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Replace document</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">76</td>
<td align="CENTER" valign="TOP">4C</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Place on job queue</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">77</td>
<td align="CENTER" valign="TOP">4D</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Send completion message</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">78</td>
<td align="CENTER" valign="TOP">4E</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Job description name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">88</td>
<td align="CENTER" valign="TOP">58</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Job description library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">98</td>
<td align="CENTER" valign="TOP">62</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Merge type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">99</td>
<td align="CENTER" valign="TOP">63</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Query name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">109</td>
<td align="CENTER" valign="TOP">6D</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Query library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">119</td>
<td align="CENTER" valign="TOP">77</td>
<td align="LEFT" valign="TOP">CHAR(12)</td>
<td align="LEFT" valign="TOP">Data document name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">131</td>
<td align="CENTER" valign="TOP">83</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Data folder name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">194</td>
<td align="CENTER" valign="TOP">C2</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">204</td>
<td align="CENTER" valign="TOP">CC</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">214</td>
<td align="CENTER" valign="TOP">D6</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Data file member name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">224</td>
<td align="CENTER" valign="TOP">E0</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Adjustment option</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">225</td>
<td align="CENTER" valign="TOP">E1</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Multiple line report</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">226</td>
<td align="CENTER" valign="TOP">E2</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Collect footnotes</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">227</td>
<td align="CENTER" valign="TOP">E3</td>
<td align="LEFT" valign="TOP">CHAR(258)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI03">DOCI0300 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for spell function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(1)</td>
<td align="LEFT" valign="TOP" width="60%">Type of check</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">1</td>
<td align="CENTER" valign="TOP">1</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Beginning page number</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Ending page number</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">15</td>
<td align="CENTER" valign="TOP">F</td>
<td align="LEFT" valign="TOP">CHAR(470)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI04">DOCI0400 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for mail function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(12)</td>
<td align="LEFT" valign="TOP" width="60%">Mail reference document name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Mail reference folder name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">75</td>
<td align="CENTER" valign="TOP">4B</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Attach mail reference</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">76</td>
<td align="CENTER" valign="TOP">4C</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Same note</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">77</td>
<td align="CENTER" valign="TOP">4D</td>
<td align="LEFT" valign="TOP">CHAR(408)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI05">DOCI0500 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for edit function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(1)</td>
<td align="LEFT" valign="TOP" width="60%">Show exit display</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">1</td>
<td align="CENTER" valign="TOP">1</td>
<td align="LEFT" valign="TOP">CHAR(484)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI06">DOCI0600 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for create function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(1)</td>
<td align="LEFT" valign="TOP" width="60%">Display exit display</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">1</td>
<td align="CENTER" valign="TOP">1</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Display document details display</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">2</td>
<td align="CENTER" valign="TOP">2</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Edit document</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">3</td>
<td align="CENTER" valign="TOP">3</td>
<td align="LEFT" valign="TOP">CHAR(482)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI07">DOCI0700 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for fill form function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(12)</td>
<td align="LEFT" valign="TOP" width="60%">Shell form</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Shell folder</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">75</td>
<td align="CENTER" valign="TOP">4B</td>
<td align="LEFT" valign="TOP">CHAR(12)</td>
<td align="LEFT" valign="TOP">Save form</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">87</td>
<td align="CENTER" valign="TOP">57</td>
<td align="LEFT" valign="TOP">CHAR(63)</td>
<td align="LEFT" valign="TOP">Save folder</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">150</td>
<td align="CENTER" valign="TOP">96</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Replace form</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">151</td>
<td align="CENTER" valign="TOP">97</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Display status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">152</td>
<td align="CENTER" valign="TOP">98</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Display exit</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">153</td>
<td align="CENTER" valign="TOP">99</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Allow refresh</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">154</td>
<td align="CENTER" valign="TOP">9A</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Dump data file</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">164</td>
<td align="CENTER" valign="TOP">A4</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">File library name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">174</td>
<td align="CENTER" valign="TOP">AE</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">File member name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">184</td>
<td align="CENTER" valign="TOP">B8</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Replace or add</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">185</td>
<td align="CENTER" valign="TOP">B9</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Output data on exit</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">186</td>
<td align="CENTER" valign="TOP">BA</td>
<td align="LEFT" valign="TOP">CHAR(299)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI08">DOCI0800 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for mail view function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="BOTTOM">Dec</th>
<th align="center" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(8)</td>
<td align="LEFT" valign="TOP" width="60%">User ID (DEN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">User address (DGN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">16</td>
<td align="CENTER" valign="TOP">10</td>
<td align="LEFT" valign="TOP">CHAR(22)</td>
<td align="LEFT" valign="TOP">Distribution ID</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">38</td>
<td align="CENTER" valign="TOP">26</td>
<td align="LEFT" valign="TOP">CHAR(447)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRI09">DOCI0900 Format</a></h3>
<p>The <a href="#HDRDCOFLD">Field Descriptions</a> explain the values to use
for send and addressing function requests.</p>
<table border width="80%">
<tr>
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
</tr>
<tr>
<th align="CENTER" valign="BOTTOM">Dec</th>
<th align="CENTER" valign="BOTTOM">Hex</th>
</tr>
<tr>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="CENTER" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">BINARY(4)</td>
<td align="LEFT" valign="TOP" width="60%">Size of format</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Offset to recipient list</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Number of addressees</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Number of copy list recipients</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">16</td>
<td align="CENTER" valign="TOP">10</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Number of blind copy list recipients</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Confirm on delivery</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">21</td>
<td align="CENTER" valign="TOP">15</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Log outgoing mail status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">22</td>
<td align="CENTER" valign="TOP">16</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Sensitivity</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">23</td>
<td align="CENTER" valign="TOP">17</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Grade of delivery</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Disclose recipients</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">25</td>
<td align="CENTER" valign="TOP">19</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Importance</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">26</td>
<td align="CENTER" valign="TOP">1A</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Allow alternate recipient</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">27</td>
<td align="CENTER" valign="TOP">1B</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Allow X.400 conversion</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Reply requested</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">29</td>
<td align="CENTER" valign="TOP">1D</td>
<td align="LEFT" valign="TOP">CHAR(7)</td>
<td align="LEFT" valign="TOP">Reply requested date</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">CHAR(6)</td>
<td align="LEFT" valign="TOP">Reply requested time</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">42</td>
<td align="CENTER" valign="TOP">2A</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Function</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">43</td>
<td align="CENTER" valign="TOP">2B</td>
<td align="LEFT" valign="TOP">CHAR(60)</td>
<td align="LEFT" valign="TOP">Subject</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">103</td>
<td align="CENTER" valign="TOP">67</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Subject character set</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">107</td>
<td align="CENTER" valign="TOP">6B</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Subject code page</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">111</td>
<td align="CENTER" valign="TOP">6F</td>
<td align="LEFT" valign="TOP">CHAR(60)</td>
<td align="LEFT" valign="TOP">Reference</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">171</td>
<td align="CENTER" valign="TOP">AB</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reference character set</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">175</td>
<td align="CENTER" valign="TOP">AF</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reference code page</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">179</td>
<td align="CENTER" valign="TOP">B3</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Memo slip character set</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">183</td>
<td align="CENTER" valign="TOP">B7</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Memo slip code page</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">187</td>
<td align="CENTER" valign="TOP">BB</td>
<td align="LEFT" valign="TOP">CHAR(30)</td>
<td align="LEFT" valign="TOP">Action item text</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">217</td>
<td align="CENTER" valign="TOP">D9</td>
<td align="LEFT" valign="TOP">CHAR(202)</td>
<td align="LEFT" valign="TOP">User's memo slip text</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">419</td>
<td align="CENTER" valign="TOP">1A3</td>
<td align="LEFT" valign="TOP">CHAR(13)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
<tr>
<td align="LEFT" valign="TOP" colspan="4"><strong>Note:</strong> The following
fields repeat as required.</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">&nbsp;</td>
<td align="CENTER" valign="TOP">&nbsp;</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">User ID (DEN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">&nbsp;</td>
<td align="CENTER" valign="TOP">&nbsp;</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">User address (DGN)</td>
</tr>
<tr>
<td align="LEFT" valign="TOP" colspan="4">
<p><strong>Notes:</strong></p>
<ol>
<li>The user ID and user address fields are in the order of addressee list,
copy list, and blind copy list. The number of users in an addressee list, a
copy list, or a blind copy list do not affect the order.<br>
<br>
</li>
<li>All character fields are left-aligned and padded by blanks unless otherwise
noted.<br>
<br>
</li>
</ol>
</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRDCOFLD">Field Descriptions</a></h3>
<p><strong>Action item text.</strong> The actual text of the action item. As
shipped, they are:</p>
<ul>
<li>For your information<br>
<br>
</li>
<li>For your comments<br>
<br>
</li>
<li>For your signature<br>
<br>
</li>
<li>For your approval<br>
<br>
</li>
<li>Please handle<br>
<br>
</li>
<li>Please circulate<br>
<br>
</li>
<li>Please see me<br>
<br>
</li>
<li>Please prepare reply<br>
<br>
</li>
</ul>
<p><strong>Additional spaces to left.</strong> The number of spaces added to
the left margin in your printed document. If the document is not printed on
both sides of the paper, this is useful when you want to bind your document.
Valid values are 0 through 99.</p>
<p><strong>Adjust line endings.</strong> The value Y (yes) adjusts line endings
in the printed document. The lines are adjusted according to what is specified
on the Line Spacing/Justification Options display. This is useful when you
print a document that has data merged into it, has instructions, has display
attributes that do not print as spaces, or uses a proportionally spaced
font.</p>
<p>The value N (no) means you do not want to adjust the line endings in the
printed document.</p>
<p><strong>Adjust page endings.</strong> The value Y (yes) adjusts page endings
in the printed document. The pages are determined by what is specified for the
<em>First typing line</em> and <em>Last typing line</em> prompts on the Page
Layout/Paper Options display.</p>
<p>The value N (no) means you do not want to adjust the page endings in the
printed document.</p>
<p><strong>Adjustment option.</strong> The values indicate the adjustment
option you want to use.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">None</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Lines (Adjusts line endings in the printed document.)</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Pages and lines (Adjusts page endings and lines in the printed
document.)</td>
</tr>
</table>
<p><strong>Allow alternate recipient.</strong> Whether the originator will
allow applications to forward or delegate the mail to some alternate
recipient.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Allow refresh.</strong> Whether the form refresh will be allowed
from within the editor. The value 1 (yes) means the form refresh option will be
allowed. The value 0 (no) means the refresh option will not be allowed.</p>
<p><strong>Allow widow lines.</strong> The value Y (yes) means the page endings
or column endings are determined by the exact number of lines per page as
specified on the Page Layout/Paper Options display. Also, use Y (yes) for the
<em>Adjust page endings</em> prompt. When you allow widows, a single line from
a paragraph could be separated from the rest of the paragraph.</p>
<p>The value N (no) means you do not want to have page endings or column
endings determined by the exact number of lines.</p>
<p><strong>Allow X.400 conversion.</strong> Whether the originator will allow
applications to make conversions to the distribution.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Attach mail reference.</strong> Whether to concatenate the original
mail item with the forward or reply operation. For MAILREPLY, this is entered
by the user on the Reply to Mail display. For MAILFWD, this will always be set
to a value of yes. The values are yes or no.</p>
<p><strong>Automatic page binding.</strong> You can choose to adjust margins
for page binding, which is a way to print pages and adjust margins for the even
pages so that they will line up with the odd pages when printing on both sides.
The values are yes or no.</p>
<p><strong>Automatically shift margins to avoid truncating text.</strong> You
can automatically shift the margin so that as much text as possible is printed
if the margin exceeds the paper edge. The values are yes or no.</p>
<p><strong>Beginning page number.</strong> A number from 1.0 through 9999.99 or
*FIRST or *LAST to specify the page on which you want spell checking to
start.</p>
<p><strong>Cancel on error.</strong> The value Y (yes) means you want the
document to stop printing if an error is detected during printing. The error is
listed in the error log with an error message stating that the job is
canceled.</p>
<p>The value N (no) means you want the document to print even if an error is
detected during printing.</p>
<p><strong>Change symbols to print.</strong> Different revision symbols result
in a document when the revision symbol is changed. If your document contains
more than one revision symbol character, and you do not select which revision
symbol characters you want to print, all revision symbol characters specified
in your document will print.</p>
<p><strong>Clear error log after printing.</strong> The value Y (yes) means you
want previous errors removed from the existing error log page before new ones
are added. This is useful if you want the error log to contain only the errors
that occurred during one printing of the document.</p>
<p>The value N (no) means you want your errors added to the end of the existing
error log page. This is useful if you want to keep a history of all the times
your document printed.</p>
<p><strong>Code page.</strong> A particular assignment of hexadecimal
identifiers to graphic characters. If you want to specify a code page, type the
graphic character-set and code-page combination. A code page is a particular
assignment of hexadecimal identifiers to graphic characters. When both the
graphic character-set ID and code-page ID are typed, they must be separated by
a hyphen.</p>
<p><strong>Collect footnotes.</strong> The value Y (yes) means you want the
associated footnote text for all Footnote instructions found in the included
text to become part of the document created during the merge function. All
Footnote instructions are changed to refer to the correct system page.</p>
<p>The value N (no) means you want the associated footnote text for all
Footnote instructions found in the included text to remain outside of the
document created during the merge function.</p>
<p><strong>Confirm on delivery.</strong> Whether to receive a notice in your
outgoing mail log confirming that the note you sent has been delivered.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Data document name.</strong> The name of the document that contains
the data to be merged.</p>
<p>The document name must be 1 to 12 characters in length.</p>
<p><strong>Data file library name.</strong> The name of the library where the
data file is located.</p>
<p><strong>Data file member name.</strong> The name of the member that contains
data.</p>
<p><strong>Data file name.</strong> The name of the file to merge data
from.</p>
<p><strong>Data folder name.</strong> The name of the folder that contains the
document that has the data to be merged.</p>
<p><strong>Delay printing.</strong> The value Y (yes) delays printing your
labels. The labels are held on the output queue where you can release them to
print or delete them if you do not want them to print.</p>
<p><strong>Device file name.</strong> The name of the file that contains the
information about the device. Use the value 3 for file.</p>
<p><strong>Device library name.</strong> A user-defined word that names a
library. The value is *LIBL.</p>
<p><strong>Device member name.</strong> The value *FILE for the member name,
means the member with the same name as the file name will be used. The values
are *FILE, *FIRST, and *LAST.</p>
<p><strong>Disclose recipients.</strong> Whether your list of addressee and
copy list recipients should be revealed to your recipients.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Display document details display.</strong> Whether you want the
Document Details display shown. The values are Y (yes) or N (no).</p>
<p><strong>Display exit.</strong> Whether the exit panel should be
displayed.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Display exit display.</strong> Whether you want the exit display
shown. The values are Y (yes) or N (no).</p>
<p><strong>Display status.</strong> Whether status lines should be shown on the
fill form display.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Document is a label document.</strong> The value (yes or no)
identifies if the document is a label document. A label document contains the
labels you are printing.</p>
<p><strong>Draft spacing.</strong> The value Y (yes) doubles the spacing value
in the <em>Line spacing</em> prompt on the Line Spacing/Justification Options
display. For example, if the <em>Line spacing</em> prompt is 3 (Triple), the
doubled spacing value is 6 and five blank lines are printed between each line
of text in your document.</p>
<p><strong>Dump data file.</strong> The name of the output file that will
contain the form fill data.</p>
<p><strong>Edit document.</strong> The values (yes or no) indicate whether you
want to edit the document.</p>
<p><strong>Ending page number.</strong> A number from 1.0 through 9999.99 or
*FIRST or *LAST to specify the page on which you want spell checking to
stop.</p>
<p><strong>Error log form type.</strong> The forms type for the type of paper
on which you want the error log to be printed. If you use the value *STD as the
forms type, the error log will be printed on the paper specified in the printer
file for the printer you selected. A printer file contains information
controlling how your document is printed on a particular printer.</p>
<p><strong>File library.</strong> The library to contain the dump data
file.</p>
<p><strong>File member.</strong> The member to contain the dump data. *FIRST is
a special value indicating the first member of the file.</p>
<p><strong>Form type.</strong> The host system form type for the forms control
table (FCT) entry.</p>
<p><strong>Function.</strong> Whether the user is forwarding or replying to a
mail item or is sending a note or document.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">User application send function requested from Send</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">User application send function requested from
Forward/Reply</td>
</tr>
</table>
<p><strong>Grade of delivery.</strong> Allows you to specify the speed of the
network for a note or message to be sent. The following values indicate the
grade of delivery to use:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">High
<p>The distribution will be sent with the highest priority on the fastest
distribution lines. It will appear highlighted in a user's mail log until the
user takes action on it.</p>
</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Normal
<p>The note or message is sent through normal distribution channels.</p>
</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Low
<p>No special priorities or distribution methods will be used to send the note
or message</p>
</td>
</tr>
</table>
<p><strong>Graphic character set.</strong> The graphic character-set ID that
you want to print your job. A graphic character-set ID is an identifier used to
specify a set of graphic characters in a code page. This identifier can be two
4-digit prompts separated by a blank or by a hyphen.</p>
<p><strong>Importance.</strong> The importance the originator places on the
content of the note. Values are as follows:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">High</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Normal</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Low</td>
</tr>
</table>
<p><strong>Job description library name.</strong> The library name by
specifying one of the following:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>name</em></td>
<td valign="top">The name of the library that is storing your job
description.</td>
</tr>
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">If you use *LIBL, your library list is searched for the job
description.</td>
</tr>
</table>
<p><strong>Job description name.</strong> The name of the job description that
describes how the job is to be run.</p>
<p><strong>Large print.</strong> The value Y (yes) prints your document with
large print.</p>
<p>The value N (no) indicates that you do not want to print your document with
large print.</p>
<p><strong>Log outgoing mail status.</strong> Whether the distribution should
be recorded in the outgoing mail status.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Mail reference document name.</strong> The document name where a
mail item is referred.</p>
<p><strong>Mail reference folder name.</strong> The folder name where the
referenced document is filed.</p>
<p><strong>Merge type.</strong> The value identifies the way the documents are
merged. The values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Query</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Document</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">File and Blank</td>
</tr>
</table>
<p><strong>Memo slip character set.</strong> The graphic character set ID of
your memo slip. A graphic character set ID is an identifier used to specify a
set of graphic characters in a code page.</p>
<p><strong>Memo slip code page.</strong> The graphic code page of your memo
slip. A graphic code page is a particular assignment of hexadecimal identifiers
to graphic characters.</p>
<p><strong>Multiple line report.</strong> The value Y (yes) means you want to
create a multiple line report. A multiple line report merges Data Field
instructions to create a report where each record of data produces several
lines of output.</p>
<p>The value N (no) means you do not want to create a multiple line report.</p>
<p><strong>Number of addressees.</strong> The number of user ID (DEN) and user
address (DGN) pairs considered primary or addressee recipients contained in
DOCI0900 format. The maximum is 32&nbsp;767.</p>
<p><strong>Number of blind copy list recipients.</strong> The number of user ID
(DEN) and user address (DGN) pairs considered blind copy list recipients
contained in DOCI0900 format. The maximum is 32&nbsp;767.</p>
<p><strong>Number of copies to print.</strong> The quantity of copies you want
printed. The valid values are from 1 through 99.</p>
<p><strong>Number of copy list recipients.</strong> The number of user ID (DEN)
and user address (DGN) pairs that are considered copy list recipients contained
in DOCI0900 format. The maximum is 32&nbsp;767.</p>
<p><strong>Number of labels.</strong> The value that identifies the amount or
quantity of labels on a page. The valid values are from 1 through 99.</p>
<p><strong>Number of rows per sheet.</strong> If you selected Y (yes) for the
<em>Sheet feed labels</em> prompt, this value from 1 through 99, is the number
of rows of labels that you want printed on a page.</p>
<p><strong>Offset to recipient list.</strong> The byte offset from the
beginning of the structure (base 0) to the start of the variable section
containing the recipient list.</p>
<p><strong>Output data on exit.</strong> Whether the output data is placed to
an output file. The values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">No</td>
</tr>
</table>
<p><strong>Output device.</strong> A device in a system by which data can be
received from the system. The values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Printer</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Display</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">File</td>
</tr>
</table>
<p><strong>Output file name.</strong> This is the name of the spooled file that
is created. The values are *DOC and *FILE.</p>
<p><strong>Output queue library name.</strong> The name of the library being
used as the current library during the processing of this command. The value is
*LIBL.</p>
<p><strong>Output queue name.</strong> A list of output files to be printed or
displayed. The output queue is used for spooled files. The values are *DEV,
*FILE, and *WRKSTN.</p>
<p><strong>Place on job queue.</strong> A document can be merged on the job
queue.</p>
<p>Use the value Y (yes) if you want the document merged on the job queue. You
can then continue working on your display while the document is being merged on
the job queue.</p>
<p>Use the value N (no) if you want the job to merge interactively.</p>
<p><strong>Print change symbols.</strong> The value Y (yes) prints revision
symbols in the left margin of your document. Revision or change symbols are
used to indicate lines that have been revised since the last time the document
was changed. The revision symbol character is specified on the Change Editing
Options display.</p>
<p>Use N (no) if you do not want to print the revision symbols in the left
margin of your document.</p>
<p><strong>Print error log.</strong> The value Y (yes) prints the error log
page at the end of your document. The log contains any errors that were found
while the document was being prepared for printing or errors found when a
document was sent from another system. The log can also contain informational
messages. If your document does not contain print errors, no log will be
printed.</p>
<p><strong>Print from pages 1 through 7.</strong> A number from 0.01 through
9999.99 to specify the page on which you want printing to start. Other valid
values are *FIRST, *LAST, or *STRPAGE. If you use *FIRST, printing is started
on the first page of the document. If you use *LAST, printing is started on the
last page of the document. If you use *STRPAGE, the <em>To page</em> and <em>
From page</em> values are the same and only one page is printed. The <em>From
page</em> and <em>To page</em> prompts tell the printer to print specific pages
from your document. The page values specified are the pages from the printed
document.</p>
<p><strong>Print line numbers.</strong> The value Y (yes) prints line numbers
in your document. The line numbers begin with 1 on the first page of your
document. Line numbers are not printed in headers or footers.</p>
<p>The value N (no) means you do not want to print line numbers in your
document.</p>
<p><strong>Print on both sides.</strong> The value indicates if you want your
document printed on one side or both sides of a page. The values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Tumble</td>
</tr>
</table>
<p><strong>Print quality.</strong> The value indicates the quality of printing
you want to use. The values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Letter
<p>Letter-quality type is better print but causes wear on the printer ribbon
(if your printer uses a ribbon) because the ribbon is struck harder.</p>
</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Text
<p>Text-quality type is not as good as letter-quality type, but is better than
draft-quality type.</p>
</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Draft
<p>Draft-quality type saves wear on the printer ribbon (if your printer uses a
ribbon) because the ribbon is not struck as hard as it would be if you were
using letter-quality type or text-quality type.</p>
</td>
</tr>
</table>
<p><strong>Print separator page.</strong> A value that determines if sheets
will separate the jobs in the printer. The value Y (yes) prints a separator
page that includes such things as the document name, folder, document
description, subject, reference, and authors. This is useful for separating
your document from other documents.</p>
<p>Use N (no) if you do not want to print a separator page.</p>
<p><strong>Print to pages 1 through 7.</strong> A number from 0.01 to 9999.99
is the page on which you want printing to stop. Other valid values are *FIRST
and *LAST. If you use *FIRST, printing is ended on the first page of the
document. If you use *LAST, printing is ended on the last page of the document.
The <em>From page</em> and <em>To page</em> prompts tell the printer to print
specific pages from your document. The page values specified are the pages from
the printed document.</p>
<p><strong>Printer device name.</strong> A device that writes output data from
a system on paper or other media.</p>
<p><strong>Printer file library name.</strong> The library name of the printer
file. Possible values are:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>name</em></td>
<td valign="top">The name of the library in which the printer file is
stored.</td>
</tr>
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">If you specify *LIBL, your library list is searched first for
the printer file.</td>
</tr>
</table>
<p><strong>Printer file name.</strong> The name of the file where you want the
printed labels to be received and stored. A file is a group of records that are
related and treated as a unit. If the file does not exist, a new file will be
created for you. If the file already exists, the document will be added to the
end of the file.</p>
<p><strong>Query library name.</strong> The name of the library that contains
the query.</p>
<p><strong>Query name.</strong> The name of the query that contains data to be
merged.</p>
<p><strong>Reference.</strong> The reference of the note or document being
passed. This will be blank if the user did not enter a reference.</p>
<p><strong>Reference character set.</strong> The graphic character-set ID of
the reference. A graphic character-set is an identifier used to specify a set
of graphic characters in a code page.</p>
<p><strong>Reference code page.</strong> The code page ID of the reference. The
code page is a particular assignment of hexadecimal identifiers to graphic
characters.</p>
<p><strong>Renumber system page numbers.</strong> The value Y (yes) renumbers
the system page numbers.</p>
<p>The value N (no) keeps the same system page numbers.</p>
<p><strong>Replace document.</strong> Whether the document replaces the
existing document (yes) or is added to the existing documents (no).</p>
<p><strong>Replace form.</strong> Whether the save form should be replaced if
it already exists.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Replace or add.</strong> Whether the data is added or replaced in
the file member.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>A</em></td>
<td valign="top">Add</td>
</tr>
<tr>
<td valign="top"><em>R</em></td>
<td valign="top">Replace</td>
</tr>
</table>
<p><strong>Reply requested.</strong> Whether the originator has requested a
reply.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<p><strong>Reply requested date.</strong> The format is CYYMMDD, where C
indicates the century digits. For example, 0 indicates years of the format
19xx, and 1 indicates years of the format 20xx.</p>
<p><strong>Reply requested time.</strong> The format is HHMMSS.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Resolve instructions.</strong> The value Y (yes) processes the
instructions that you have placed in your document.</p>
<p><strong>Resolved output document.</strong> The saved document is a resolved
document (saved in printed form), that is, page endings are adjusted, line
endings are adjusted, headers and footers are put in, and instructions are
processed (optional). If you wish to print this document again, it takes less
time to print because this document is already in printed form. (A resolved
document is a document with the text instructions processed.) This document can
be from the text editor or another system.</p>
<p><strong>Resolved output folder.</strong> The name of the folder that will
contain the document you specified in the <em>Document name</em> prompt. If the
folder does not exist, a message is shown before it is created.</p>
<p><strong>Save folder.</strong> The folder name where the save form document
is saved.</p>
<p><strong>Save form.</strong> The name of the document to save the results of
the fill form process.</p>
<p><strong>Save resolved output.</strong> The value Y (yes) means the document
you are printing is saved in the document specified in the document prompt.</p>
<p>The value N (no) means you do not want the document you are printing saved
in another document.</p>
<p><strong>Send completion message.</strong> The value Y (yes) means you are
putting your print job on the job queue and you want a message sent to your
display station when the job has completed.</p>
<p>The value N (no) means you are putting your print job on the job queue and
you do not want a message sent to your display station when the job has
completed.</p>
<p><strong>Sensitivity.</strong> An indicator of the sensitivity of the content
of the note. Values are as follows:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">None</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Personal</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Private</td>
</tr>
<tr>
<td valign="top"><em>4</em></td>
<td valign="top">Confidential</td>
</tr>
</table>
<p><strong>Shell folder.</strong> The folder containing the shell form.</p>
<p><strong>Shell form.</strong> The shell document for fill form.</p>
<p><strong>Sheet-feed labels.</strong> A value that defines that a device is
attached to a printer to automatically feed out sheets of labels. The value Y
(yes) means you are sheet-feed printing and want more than one row of labels on
a page. If you are using sheet-feed paper, there is no other way to print more
than one row of labels on a page.</p>
<p><strong>Show exit display.</strong> Whether you want the exit display shown.
The valid values are Y (yes) or N (no).</p>
<p><strong>Size of format.</strong> The complete size of format DOCI0900,
including any variable length records.</p>
<p><strong>Subject.</strong> The subject of the note or document being passed.
This will be blank if the user did not enter a subject.</p>
<p><strong>Subject character set.</strong> The graphic character set ID of the
subject. A graphic character set is an identifier used to specify a set of
graphic characters in a code page.</p>
<p><strong>Subject code page.</strong> The code page ID of the subject. The
code page is a particular assignment of hexadecimal identifiers to graphic
characters.</p>
<p><strong>To document name.</strong> The name of the document to be merged
with.</p>
<p><strong>To folder name.</strong> The name of the folder that will contain
the document being created.</p>
<p><strong>Type of check.</strong> The value indicates if you want to check the
spelling or the grade level.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Spell</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Grade</td>
</tr>
</table>
<p><strong>User address.</strong> The recipient address or DGN.</p>
<p><strong>User ID.</strong> The recipient name or DEN.</p>
<p><strong>User's memo slip text.</strong> User's text typed on the <em>Attach
Memo Slip</em> display.</p>
<p><strong>Width of labels.</strong> The width of a label is the number of
characters from the left edge of the first label to the left edge of the next
label, including the blank spaces between the labels. If the width you specify
is larger than the margins for your document, the margins are used as the
width. Valid values are 2 through 198.</p>
<p><strong>Note:</strong> For the printer device field the special values
*SYSVAL, *USRPRF, and *WRKSTN are replaced with the appropriate printer name,
therefore the exit program does not use the special values.</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">OFC169A</td>
<td valign="top">User exit programs canceled by program &amp;1 in library
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">OFC169B</td>
<td valign="top">Error with administration user exit programs.</td>
</tr>
<tr>
<td align="left" valign="top">OFC1691</td>
<td valign="top">Error occurred using Office application enabler.</td>
</tr>
<tr>
<td align="left" valign="top">OFC1695</td>
<td valign="top">Error occurred when calling program &amp;1 in library
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">OFC1696</td>
<td valign="top">Return code &amp;1 from program &amp;2 in library &amp;3 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">OFC1698</td>
<td valign="top">Error calling user exit program &amp;1 in library &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">OFC1699</td>
<td valign="top">Error on retrieval of user exit program.</td>
</tr>
<tr>
<td align="left" valign="top">OFC2096</td>
<td valign="top">The user application send processing has returned &amp;1.</td>
</tr>
</table>
<br>
<hr>
Exit program introduced: V2R2
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"off1.htm">Office APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>