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

181 lines
4.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>ldap_next_message()--Retrieve Next LDAP Message</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- File Edited March 2001 -->
<!-- This file has undergone html cleanup on 2/19/02 by JET -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>ldap_next_message()--Retrieve Next LDAP Message</h2>
<br>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
LDAPMessage *ldap_next_message(
LDAP *<em>ld</em>,
LDAPMessage *<em>msg</em>)
</pre>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library Name/Service Program: QSYS/QGLDCLNT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>ldap_next_message()</strong> function is used to step through
the list of messages in a result chain, as returned by <a href=
"ldap_result.htm">ldap_result()</a> and <a href="ldap_first_msg.htm">
ldap_first_message()</a>. It is used to return a pointer to the next message
from the list.</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><em>ld</em></dt>
<dd>(Input) Specifies the LDAP pointer returned by a previous call to <a href=
"ldap_init.htm">ldap_init()</a>, <a href="ldap_ssl_init.htm">
ldap_ssl_init()</a>, or <a href="ldap_open.htm">ldap_open()</a>.</dd>
<dt><em>msg</em></dt>
<dd>(Input) Specifies the message returned by a previous call to <a href=
"ldap_first_msg.htm">ldap_first_message()</a> or <strong>
ldap_next_message()</strong>.</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>LDAPMessage *</strong></dt>
<dd>pointer to the next message in list.<br>
<br>
</dd>
<dt><strong>NULL</strong></dt>
<dd>when no more messages exist in the result set to be returned or if an error
occurs.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>If <strong>ldap_next_message()</strong> is not successful, <em>ld_errno</em>
will be set to indicate the error. See <a href="ldap_error_condt.htm">LDAP
Client API Error Conditions</a> for possible LDAP error code values. Use the <a
href="ldap_get_errno.htm">ldap_get_errno()</a> function to retrieve the error
information.</p>
<br>
<h3>Error Messages</h3>
<p>The following message may be sent from this function.</p>
<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">CPF3CF2 E</td>
<td width="85%" valign="top">Error(s) occurred during running of
ldap_next_message API.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="ldap_count_msg.htm">ldap_count_messages()</a> -- Return the number
of messages in a result chain.</li>
<li><a href="ldap_first_entry.htm">ldap_first_entry()</a> -- Retrieve first
LDAP entry.</li>
<li><a href="ldap_first_msg.htm">ldap_first_message()</a> -- Retrieve first
LDAP message.</li>
<li><a href="ldap_first_ref.htm">ldap_first_reference()</a> -- Return first
continuation reference in a chain of search results.</li>
<li><a href="ldap_msgfree.htm">ldap_msgfree()</a> -- Free LDAP Result
Message.</li>
<li><a href="ldap_msgid.htm">ldap_msgid()</a> -- Retrieve Message ID Associated
with an LDAP Message.</li>
<li><a href="ldap_msgtype.htm">ldap_msgtype()</a> -- Retrieve Type of an LDAP
Message.</li>
<li><a href="ldap_result2error.htm">ldap_result2error()</a> -- Retrieve LDAP
Error Information.</li>
</ul>
<br>
<hr>
API introduced: V4R5
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="dirserv1.htm">LDAP APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>