friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qxdaprog.htm

375 lines
9.4 KiB
HTML
Raw Blame History

<!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>Call Program (QxdaCallProgramEDRS) API</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- File SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited March 2001 -->
<!-- This file has undergone html cleanup on 9/19/01 by JET -->
<!--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>Call Program (QxdaCallProgramEDRS) API</h2>
<div class="box" style="width: 80%;">
<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%">Connection handle</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Qualified program name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Number of parameters</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">Parameter information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QXDAEDRS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Conditional; see <a href="#usage_notes">Usage Notes</a>
<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Call Program (QxdaCallProgramEDRS) API is used to call a user-defined
program on the database server system. All parameters are passed to the program
by reference.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Any program</em></dt>
<dd>*USE</dd>
<dt><em>Library of the program</em></dt>
<dd>*EXECUTE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Connection handle</strong></dt>
<dd>INPUT; BINARY(4)
<p>The handle number of the connection on which to call the program. The
connection handle must have been generated by the QxdaConnectEDRS API in the
current job and activation group.</p>
</dd>
<dt><strong>Qualified program name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The library and name of the program to call. The special value *LIBL may be
specified for the library name; however, the library list of the server job may
differ from that of the client job.</p>
</dd>
<dt><strong>Number of parameters</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of parameters to pass to the program.</p>
</dd>
<dt><strong>Parameter information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information about each of the parameters. This should be an array of type
Qxda_ParmInfo_t, with one entry for each parameter. For the format of each
array element, see <a href="#HDRPRMINF">Qxda_ParmInfo_t Format</a>.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRPRMINF">Qxda_ParmInfo_t Format</a></h3>
<p>The following table shows the structure of the Qxda_ParmInfo_t format. For
more details about the fields in this table, see <a href="#HDRFIELD6">Field
Descriptions</a>.</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%">PTR</td>
<td align="left" valign="top" width="60%">Parameter address</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">Parameter type</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Parameter length</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Parameter usage</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFIELD6">Field Descriptions</a></h3>
<p><strong>Parameter address.</strong> The address where an input parameter
exists or where an output parameter should be returned.</p>
<p><strong>Parameter length.</strong> The number of bytes allocated for the
parameter.</p>
<p><strong>Parameter type.</strong> The type of the parameter. The possible
values are:</p>
<table width="100%" cellpadding="5">
<tr>
<td width="20%" valign="top"><em>1 - QXDA_BIN4</em></td>
<td width="80%" valign="top">The parameter at the address specified is a
BINARY(4) value.</td>
</tr>
<tr>
<td valign="top"><em>2 - QXDA_CHAR</em></td>
<td valign="top">The parameter at the address specified is a character string.
If the API is being called from an i5/OS application, no CCSID conversion is
performed.</td>
</tr>
<tr>
<td valign="top"><em>3 - QXDA_HEX</em></td>
<td valign="top">The parameter at the address specified is hexadecimal data and
requires no conversion.</td>
</tr>
<tr>
<td valign="top"><em>3 - QXDA_BIN2</em></td>
<td valign="top">The parameter at the address specified is a BINARY(2) value.
If the API is being called from an i5/OS application, you cannot use this
value.</td>
</tr>
</table>
<br>
<p><strong>Parameter usage.</strong> The usage of the parameter. The possible
values are:</p>
<table width="100%">
<tr>
<td width="20%" valign="top"><em>0 - QXDA_INPUT</em></td>
<td width="80%" valign="top">The parameter is used for input only.</td>
</tr>
<tr>
<td valign="top"><em>1 - QXDA_OUTPUT</em></td>
<td valign="top">The parameter is used for output only.</td>
</tr>
<tr>
<td valign="top"><em>2 - QXDA_IN_OUT</em></td>
<td valign="top">The parameter is used for both input and output.</td>
</tr>
</table>
<br>
<p><strong>Reserved.</strong> Reserved field; it must be initialized to
0x00.</p>
<br>
<h3><a name="usage_notes">Usage Notes</a></h3>
<p>This function may be called from the initial thread of a job only. For the
i5/OS version of this API, the QXDA_CHAR and QXDA_HEX parameter types are
equivalent.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF180C E</td>
<td width="85%" valign="top">Function &amp;1 not allowed.</td>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
<tr>
<td valign="top">CPFAE14 E</td>
<td valign="top">Cannot allocate &amp;1 bytes.</td>
</tr>
<tr>
<td valign="top">CPFB750 E</td>
<td valign="top">Connection handle specified not valid.</td>
</tr>
<tr>
<td valign="top">CPFB752 E</td>
<td valign="top">Internal error in &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPFB755 E</td>
<td valign="top">Program &amp;1 in library &amp;2 not found.</td>
</tr>
<tr>
<td valign="top">CPFB756 E</td>
<td valign="top">Rollback operation performed.</td>
</tr>
<tr>
<td valign="top">CPFB757 E</td>
<td valign="top">The connection is suspended.</td>
</tr>
<tr>
<td valign="top">CPFB758 E</td>
<td valign="top">The EDRS server system has been switched.</td>
</tr>
</table>
<br>
<br>
<hr>
API introduced: V4R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"file1.htm">Database and File APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
<br>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink