<!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_count_messages()--Count messages in a result chain</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 --> <!-- This file has undergone html cleanup on 2/18/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_count_messages()--Count messages in a result chain</h2> <div class="box" style="width: 70%;"> <br> Syntax<br> <pre> #include <ldap.h> int ldap_count_messages(LDAP *<em>ld</em>, LDAPMessage *<em>result</em>) </pre> <br> Library Name/Service Program: QSYS/QGLDCLNT<br> <!-- iddvc RMBR --> <br> Default Public Authority: *USE<br> <!-- iddvc RMBR --> <br> Threadsafe: Yes<br> <!-- iddvc RMBR --> <br> </div> <p>The <strong>ldap_count_messages()</strong> routine is used to step through the list of messages in a result chain, as returned by <a href= "ldap_result.htm">ldap_result()</a>. It is used to count the number of messages returned. The <a href="ldap_msgtype.htm">ldap_msgtype()</a> API can be used to distinguish between the different message types.</p> <p>In addition to returning the number of messages contained in a chain of results, the <strong>ldap_count_messages()</strong> API can be used to count the number of messages that remain in a chain if called with a message, entry, or reference returned by <strong>ldap_first_message()</strong>, <strong> ldap_next_message()</strong>, <strong>ldap_first_entry()</strong>, <strong> ldap_next_entry()</strong>, <strong>ldap_first_reference()</strong> and <strong>ldap_next_reference()</strong>.</p> <br> <h3>Authorities and Locks</h3> <p>No i5/OS authority is required.</p> <br> <h3>Parameters</h3> <dl> <dt><strong><em>ld</em></strong></dt> <dd>(Input) 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>.<br><br></dd> <dt><strong><em>result</em></strong></dt> <dd>(Input) The result returned by a call to <strong>ldap_result()</strong> or one of the synchronous search routines (<a href="ldap_search_s.htm">ldap_search_s()</a>, <a href="ldap_search_st.htm">ldap_search_st()</a>, or <a href="ldap_search_ext_s.htm">ldap_search_ext_st()</a>).</dd> </dl> <br> <h3>Return Value</h3> <dl> <dt><strong>Number of Messages</strong></dt> <dd>If the request was successful, <strong>ldap_count_messages()</strong> API retuns the number of messages in a result chain or number of messages that remain in a chain, as returned by <strong>ldap_result()</strong>.<br> <br> </dd> <dt><strong>-1</strong></dt> <dd>if the request was not successful.</dd> </dl> <br> <h3>Error Conditions</h3> <p>If <strong>ldap_count_messages()</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 <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="5"> <tr> <th align="left" valign="top" nowrap>Message ID</th> <th align="left" valign="top">Error Message Text</th> </tr> <tr> <td align="left" valign="top">CPF3CF2 E</td> <td align="left" valign="top">Error(s) occurred during running of ldap_count_messages API.</td> </tr> </table> <br> <br> <h3>Related Information</h3> <ul> <li><a href="ldap_first_msg.htm">ldap_first_message()</a> -- Return first message in a result chain.</li> <li><a href="ldap_next_msg.htm">ldap_next_message()</a> -- Return next message in a result chain.</li> </ul> <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>