194 lines
5.7 KiB
HTML
194 lines
5.7 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_attribute()--Retrieve First Attribute in an Entry</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 April 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_attribute()--Retrieve First Attribute in an Entry</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
char *ldap_first_attribute(
|
|
LDAP *<em>ld</em>,
|
|
LDAPMessage *<em>entry</em>,
|
|
BerElement **<em>berptr</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_attribute()</strong> function returns the first
|
|
attribute in an entry. The <strong>ldap_first_attribute()</strong> and <a href=
|
|
"ldap_next_attr.htm">ldap_next_attribute()</a> functions are used to step
|
|
through the attributes in an LDAP entry.</p>
|
|
|
|
<p><strong>ldap_first_attribute()</strong> takes an entry returned by <a href=
|
|
"ldap_first_entry.htm">ldap_first_entry()</a> or <a href="ldap_next_entry.htm">
|
|
ldap_next_entry()</a> and returns a pointer to a buffer containing a null
|
|
terminated string that is the first attribute type in the entry. This buffer
|
|
must be freed when its use is completed using <a href="ldap_memfree.htm">
|
|
ldap_memfree()</a>. *<em>berptr</em> also must be freed when its use is
|
|
completed using <a href="ldap_ber_free.htm">ldap_ber_free()</a>.</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>,
|
|
<a href="ldap_app_ssl_init_np.htm">ldap_app_ssl_init_np()</a>, or
|
|
<a href="ldap_open.htm">ldap_open()</a>.<br><br></dd>
|
|
|
|
<dt><strong><em>entry</em></strong></dt>
|
|
|
|
<dd>(Input) The attribute information as returned by
|
|
<a href="ldap_first_entry.htm">ldap_first_entry()</a> or
|
|
<a href="ldap_next_entry.htm">ldap_next_entry()</a>.<br><br></dd>
|
|
|
|
<dt><strong><em>berptr</em></strong></dt>
|
|
|
|
<dd>(Output) A pointer to a BerElement that will be allocated to keep track of
|
|
the current position. It is an input and output parameter for subsequent calls
|
|
to <a href="ldap_next_attr.htm">ldap_next_attribute()</a>. The BerElement
|
|
structure is opaque to the application. Free *<em>berptr</em> when its use is
|
|
completed using <strong>ber_free</strong>.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Pointer to a buffer containing the first attribute type in the
|
|
entry</strong></dt>
|
|
|
|
<dd>if the request was successful.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>NULL</strong></dt>
|
|
|
|
<dd>if the request was not successful.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>ldap_first_attribute()</strong> is not successful, NULL is
|
|
returned, and <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_attribute API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_first_entry.htm">ldap_first_entry()</a> -- Retrieve first
|
|
LDAP entry.</li>
|
|
|
|
<li><a href="ldap_next_entry.htm">ldap_next_entry()</a> -- Retrieve next LDAP
|
|
entry.</li>
|
|
|
|
<li><a href="ldap_count_attr.htm">ldap_count_attributes()</a> -- Retrieve count
|
|
of attributes for an LDAP entry.</li>
|
|
|
|
<li><a href="ldap_next_attr.htm">ldap_next_attribute()</a> -- Return next
|
|
attribute name in an entry.</li>
|
|
|
|
<li><a href="ldap_get_values.htm">ldap_get_values()</a> -- Retrieve a set of
|
|
attribute values from an entry.</li>
|
|
|
|
<li><a href="ldap_get_values_len.htm">ldap_get_values_len()</a> -- Retrieve a
|
|
set of binary attribute values.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V4R3
|
|
|
|
<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>
|
|
|