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

294 lines
8.3 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>Send Reply (QNMSNDRP) 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. -->
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited December, 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Send Reply (QNMSNDRP) API</h2>
<div class="box" style="width: 60%;">
<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%">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">Request Identifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(53)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Send buffer</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Length of send buffer</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Reply type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Wait time</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">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Send Reply (QNMSNDRP) API, an SNA/Management Services Transport API, sends a reply to a request that was received from a source application. Single or multiple replies may be sent for a particular request. The received request must have indicated that a reply is expected.</p>
<p>Multiple replies are sent by calling the Send Reply (QNMSNDRP) API one or more times. To send multiple replies, the reply type parameter is set to incomplete until the last reply is sent, when it is set to complete.</p>
<p>If the wait time is 0, then an entry is placed on the data queue when the operation is complete. If multiple replies are sent without waiting (wait time equals 0), multiple entries are placed on the data queue.</p>
<p>The same mode name used with the Send Request (QNMSNDRQ) API is used for the reply. See the <a href="QNMSNDRQ.htm">Send Request (QNMSNDRQ) API</a> for more information about sending a request.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Handle</strong></dt>
<dd>INPUT; BINARY(4)
<p>The unique identifier for this application.</p>
</dd>
<dt><strong>Request identifier</strong></dt>
<dd>INPUT; CHAR(53)
<p>The request identifier of the corresponding request. The request identifier is returned when the original request is received.</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*PRV</em></td>
<td valign="top">The last request identifier used (for example, the one specified on the Receive Data (QNMRCVDT) API).</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Send buffer</strong></dt>
<dd>INPUT; CHAR(*)
<p>The data being sent.</p>
</dd>
<dt><strong>Length of send buffer</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the data being sent. The send buffer can range in size from 0 through 31739.</p>
</dd>
<dt><strong>Reply type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of data being sent:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*RPYCPL</em></td>
<td valign="top">The last or only reply (the reply is complete).</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RPYINCPL</em></td>
<td valign="top">Additional replies will be sent (the reply is incomplete).</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Wait time</strong></dt>
<dd>INPUT; BINARY(4)
<p>The amount of time the application waits for the send operation to complete.</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td valign="top">Waits for the send operation to complete or for a condition such that the operation cannot complete (for example, a communications failure).</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The application does not wait for the operation to complete.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-99999</em></td>
<td valign="top">The number of seconds the application waits.</td>
</tr>
</table>
<br>
</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>Error Messages</h3>
<table width="100%" 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">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AC0 E</td>
<td valign="top">&amp;3.&amp;4 cannot receive data at this time.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AC1 E</td>
<td valign="top">Reply cannot be sent.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7ADC E</td>
<td valign="top">Internal processing error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7ADD E</td>
<td valign="top">Operation did not complete.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7ADF E</td>
<td valign="top">Session failure. Cannot send data at this time.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AD2 E</td>
<td valign="top">Send buffer length value &amp;3 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AD5 E</td>
<td valign="top">Reply type value &amp;3 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AEC E</td>
<td valign="top">Wait time &amp;3 not between -1 and 99999.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AE2 E</td>
<td valign="top">Handle &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AE6 E</td>
<td valign="top">Communication with control point &amp;3.&amp;4 failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7AE9 E</td>
<td valign="top">Request identifier not valid.</td>
</tr>
<tr>
<td align="left" 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>
</table>
<br>
<hr>
API introduced: V2r1.1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
href="netmg.htm">Network Management APIs</a> | <a href="aplist.htm">APIs
by category</a></td>
</tr>
</table>
</center>
</body>
</html>