127 lines
6.6 KiB
HTML
127 lines
6.6 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="topic" />
|
||
|
|
<meta name="DC.Title" content="Receive CGI Stateful Data (QzhbCgiRecvState) API" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzaieapi_qzhbcgirecvstate" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Receive CGI Stateful Data (QzhbCgiRecvState) API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhbcgirecvstate"><a name="rzaieapi_qzhbcgirecvstate"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Receive CGI Stateful Data (QzhbCgiRecvState) API</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Target buffer</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Output</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Length of target buffer</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Length of response</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Output</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Continuation handle</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Error Code</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>Use the <em>QzhbCgiRecvState</em> API with HA CGI programs to receive the
|
||
|
|
CGI stateful data. The HTTP Server receives the data for the next request
|
||
|
|
to the stateful CGI so that if a failover occurs the data is available on
|
||
|
|
the backup system (new primary system). This API is used with API <em>QzhbCgiSendState</em>.</p>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>Target buffer</strong></dt>
|
||
|
|
<dd>OUTPUT:CHAR(*) <p>The target buffer containing the state of a high availability
|
||
|
|
CGI program.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Length of target buffer</strong></dt>
|
||
|
|
<dd>INPUT:BINARY(4)<p>The length of the target buffer that receives the API
|
||
|
|
output. The minimum length is 1 byte and the maximum length is 61,000 bytes.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Length of response</strong></dt>
|
||
|
|
<dd>OUTPUT:BINARY(4) <p>The length of response is the actual length of the
|
||
|
|
information that is returned from the target buffer. If this value is greater
|
||
|
|
than the length of the target buffer, then there is more state to read. The
|
||
|
|
difference between these two values represents the amount of bytes the caller
|
||
|
|
should read in subsequent calls to this API.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Continuation handle</strong></dt>
|
||
|
|
<dd>I/O:CHAR(*) <p>The continuation handle is the handle that is returned
|
||
|
|
when more data is available to return, but the target buffer is not large
|
||
|
|
enough. The caller must pass this handle to this API on subsequent calls as
|
||
|
|
it was received from the previous call. On the first call to this API, the
|
||
|
|
continuation handle must be set to 0 (equivalent to NULL in C). The caller
|
||
|
|
must not allocate, deallocate, or modify the continuation handle. This field
|
||
|
|
is set to 0 when all information is returned.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><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 API Error Reporting in the iSeries™ Information
|
||
|
|
Center.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>CPF24B4 E</strong></dt>
|
||
|
|
<dd>Severe Error while addressing parameter list.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>CPF3C17 E</strong></dt>
|
||
|
|
<dd>Error occurred with input data parameter.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>CPF3CF1 E</strong></dt>
|
||
|
|
<dd>Error code parameter not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTP4005 E</strong></dt>
|
||
|
|
<dd>Highly Available CGI invoked QzhbCgiRecvState() after it had already received
|
||
|
|
the entire state.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm">HTP4006 E</dt>
|
||
|
|
<dd>QzhbCgiRecvState() was called when there was no state.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|