267 lines
7.8 KiB
HTML
267 lines
7.8 KiB
HTML
<!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 Conversion 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 Conversion Exit Program</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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%">Input 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">Input 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">Input 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">Output document name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(12)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Output 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">6</td>
|
|
<td align="left" valign="top">Output 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">7</td>
|
|
<td align="left" valign="top">Function code</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Conversion existence indicator</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
</table><br>
|
|
</div>
|
|
|
|
<p>The Document Conversion exit program allows other document conversions to be called when a request
|
|
is made for the OfficeVision program to process a document type that it does not support. The i5/OS and
|
|
OfficeVision programs use document conversions when opening documents.</p>
|
|
|
|
<br>
|
|
<h3>Program Registration</h3>
|
|
|
|
<p>To register a user exit program, use the Change Office Program (QOGCHGOE) API.</p>
|
|
|
|
<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>Input document name</strong></dt>
|
|
<dd>INPUT; CHAR(12)
|
|
|
|
<p>The name of the document the function is to be performed against.</p></dd>
|
|
|
|
<dt><strong>Input folder name</strong></dt>
|
|
<dd>INPUT; CHAR(63)
|
|
|
|
<p>The folder in which the document is to be found.</p></dd>
|
|
|
|
<dt><strong>Input 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 in the range of 1 through 65535.</p></dd>
|
|
|
|
<dt><strong>Output document name</strong></dt>
|
|
<dd>INPUT; CHAR(12)
|
|
|
|
<p>The name of the output document.</p></dd>
|
|
|
|
<dt><strong>Output folder name</strong></dt>
|
|
<dd>INPUT; CHAR(63)
|
|
|
|
<p>The folder in which the output document is to be placed.</p></dd>
|
|
|
|
<dt><strong>Output document type</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The format of the document that is being worked with. The value must be in the range of 1 through 65535.</p></dd>
|
|
|
|
<dt><strong>Function code</strong></dt>
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Whether the exit is being called to check for the existence of a conversion or to perform the conversion.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td valign="top">A conversion is being requested.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">An existence check is requested.</td>
|
|
</tr>
|
|
</table>
|
|
<br></dd>
|
|
|
|
<dt><strong>Conversion existence indicator</strong></dt>
|
|
<dd>OUTPUT; CHAR(1)
|
|
|
|
<p>Whether the requested conversion exists. This flag must be set for both conversion existence checks and conversion requests.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td valign="top">Conversion does not exist.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Conversion exists.</td>
|
|
</tr>
|
|
</table>
|
|
<br></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Use of Document Conversions by IBM Programs</h3>
|
|
|
|
<p>Other document conversions will be called when you are opening documents and:</p>
|
|
|
|
<ul>
|
|
<li>Processing the following document commands and using the OfficeVision editor or print functions:
|
|
|
|
<blockquote>
|
|
<p>CRTDOC</p>
|
|
<p>EDTDOC</p>
|
|
<p>DSPDOC</p>
|
|
<p>PRTDOC</p>
|
|
<p>CHKDOC</p>
|
|
<p>MRGDOC</p>
|
|
<p>PAGDOC</p>
|
|
<p>ADDTXTIDXE</p>
|
|
</blockquote></li>
|
|
|
|
<li>Processing the following options from the Work with Documents in Folders display and using OfficeVision:
|
|
|
|
<blockquote>
|
|
<p>Create</p>
|
|
<p>Revise</p>
|
|
<p>View</p>
|
|
<p>Print</p>
|
|
<p>Spell</p>
|
|
<p>Paginate</p>
|
|
<p>Print options</p>
|
|
</blockquote></li>
|
|
|
|
<li>Processing the following options from the Work with Documents in a Document List display:
|
|
|
|
<blockquote>
|
|
<p>Revise</p>
|
|
<p>View</p>
|
|
<p>Print</p>
|
|
</blockquote></li>
|
|
|
|
<li>Processing the following options from the Work with Mail display and using OfficeVision:
|
|
|
|
<blockquote>
|
|
<p>Revise a copy</p>
|
|
<p>View</p>
|
|
<p>Print</p>
|
|
<p>Forward</p>
|
|
<p>Reply</p>
|
|
</blockquote></li>
|
|
|
|
<li>Copying a document on a create request when using the OfficeVision editor.<br><br></li>
|
|
|
|
<li>Recalling from or copying or moving to a notepad document within the OfficeVision editor.<br><br></li>
|
|
|
|
<li>Using the GET function within the OfficeVision editor.<br><br></li>
|
|
|
|
<li>Including a document with the .inc instruction in the OfficeVision print function.<br><br></li>
|
|
|
|
<li>Accessing external footnote documents in the OfficeVision print function.<br><br></li>
|
|
|
|
<li>Accessing a fill-in document (merge from a document) in the OfficeVision print function.<br><br></li>
|
|
|
|
<li>Accessing shell documents QPROFNOT and QPROFDOC for converting incoming PROFS documents and notes.<br><br></li>
|
|
|
|
<li>Printing mail for indirect office users.<br><br></li>
|
|
|
|
<li>Accessing the shell note when creating a note.<br><br></li>
|
|
|
|
<li>Accessing the output document for a copy graph or image request.<br><br></li>
|
|
</ul>
|
|
|
|
<p>In each of these cases a conversion from the current format to RFTDCA or FFTDCA is requested. A second
|
|
conversion from this resulting format to i5/OS format may also be performed using the IBM conversion programs.</p>
|
|
<br>
|
|
<hr>
|
|
Exit Program Introduced: V2R2
|
|
|
|
<hr>
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
|
|
href="off1a.htm">Office APIs</a> | <a href=
|
|
"aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html>
|