ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhbgetnextgroup.htm

110 lines
5.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="Retrieve the next Group in the Group List (QzhbGetNextGroup) 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_qzhbgetnextgroup" />
<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>Retrieve the next Group in the Group List (QzhbGetNextGroup) API</title>
</head>
<body id="rzaieapi_qzhbgetnextgroup"><a name="rzaieapi_qzhbgetnextgroup"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Retrieve the next Group in the Group List (QzhbGetNextGroup) 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%">grplist</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%">2</td>
<td valign="top" width="31.313131313131315%">prev_grp</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%">grp</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%">errcode</td>
<td valign="top" width="31.060606060606062%">I/O</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
</tr>
</tbody>
</table>
</div>
<p>Use the <em>QzhbGetNextGroup</em> API to retrieve the next group from an
in-memory group list.</p>
</div>
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
<div><p>None.</p>
</div>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>grplist</strong></dt>
<dd>INPUT:BINARY(4) <p>The group list handle returned from a call to the <em>QzhbCreateGroupList</em> or <em>QzhbOpenGroupList</em> API.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>prev_grp</strong></dt>
<dd>INPUT:BINARY(4) <p>The group handle returned from a call to the <em>QzhbGetNextGroup</em>, <em>QzhbGetNextGroup</em>, <em>QzhbFindGroupInList</em>,
or <em>QzhbAddGroupToList</em> API, that returns the group immediately following
this group. A handle of 0 returns the first group in the group list.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>grp</strong></dt>
<dd>OUTPUT:BINARY(4)<p>The group name handle returned if the next group is
found in the list. If no next group exists, then error HTPA206 is returned.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>errcode</strong></dt>
<dd>I/O:CHAR(*) <p>The structure in which to return error information.</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>CPF3CF1 E</strong></dt>
<dd>Error code parameter not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA001 E</strong></dt>
<dd>Input parameter &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA203 E</strong></dt>
<dd>Input group list handle in parameter &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA204 E</strong></dt>
<dd>Input group handle in parameter &amp;1 not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>HTPA206 E</strong></dt>
<dd>Group file &amp;1 not found in group list.</dd>
</dl>
</div>
</div>
</body>
</html>