183 lines
5.1 KiB
HTML
183 lines
5.1 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_first_reference()--Retrieve First Continuation Reference in a Chain
|
|
of Search Results</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_first_reference()--Retrieve First Continuation Reference in a Chain of
|
|
Search Results</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
LDAPMessage *ldap_first_reference(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_first_reference()</strong> is used to return the first
|
|
continuation reference from the search result chain.</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
|
|
<a href="ldap_result.htm">ldap_result()</a> 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_s()</a>).</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>LDAPMessage *</strong></dt>
|
|
|
|
<dd>Pointer to the first continuation reference. The pointer returned from
|
|
<strong>ldap_first_reference()</strong> should be supplied on a subsequent call
|
|
to <a href="ldap_next_ref.htm">ldap_next_reference()</a> to get the next
|
|
continuation reference.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>NULL</strong></dt>
|
|
|
|
<dd>when no more continuation references exist in the result set to be
|
|
returned.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>ldap_first_reference()</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 cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<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_first_reference API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_first_entry.htm">ldap_first_entry()</a> -- Return first entry
|
|
in a chain of search results.</li>
|
|
|
|
<li><a href="ldap_next_entry.htm">ldap_next_entry()</a> -- Return next entry in
|
|
a chain of search results.</li>
|
|
|
|
<li><a href="ldap_count_entry.htm">ldap_count_entry()</a> -- Return number of
|
|
entry in a chain of search results.</li>
|
|
|
|
<li><a href="ldap_get_entry_cntrls_np.htm">ldap_get_entry_controls_np()</a> --
|
|
Extract server controls from an entry.</li>
|
|
|
|
<li><a href="ldap_count_ref.htm">ldap_count_reference()</a> -- Return the
|
|
number of continuation reference in a chain of search results.</li>
|
|
|
|
<li><a href="ldap_next_ref.htm">ldap_next_reference()</a> -- Return next
|
|
continuation reference in a chain of search results.</li>
|
|
|
|
<li><a href="ldap_parse_ref_np.htm">ldap_parse_reference_np()</a> -- Extract
|
|
information from a continuation reference.</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>
|