181 lines
4.8 KiB
HTML
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_get_values()--Retrieve a Set of Attribute Values from 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 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_get_values()--Retrieve a Set of Attribute Values from an Entry</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
char **ldap_get_values(
|
||
|
|
LDAP *<em>ld</em>,
|
||
|
|
LDAPMessage *<em>entry</em>,
|
||
|
|
const char *<em>attr</em>)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_get_values()</strong> function is used to retrieve
|
||
|
|
attribute values from an LDAP entry as returned by <a href=
|
||
|
|
"ldap_first_entry.htm">ldap_first_entry()</a> or <a href="ldap_next_entry.htm">
|
||
|
|
ldap_next_entry()</a>. <strong>ldap_get_values()</strong> uses the entry and
|
||
|
|
the attribute attr whose values are wanted and returns a NULL-terminated array
|
||
|
|
of the attribute's values. The returned array should be freed with <a href=
|
||
|
|
"ldap_value_free.htm">ldap_value_free()</a> when it is no longer needed.</p>
|
||
|
|
|
||
|
|
<p>Use <a href="ldap_get_values_len.htm">ldap_get_values_len()</a> to get
|
||
|
|
binary attribute values.</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>entry</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies an LDAP entry as returned from <a href=
|
||
|
|
"ldap_first_entry.htm">ldap_first_entry()</a> or <a href="ldap_next_entry.htm">
|
||
|
|
ldap_next_entry()</a>.</dd>
|
||
|
|
|
||
|
|
<dt><em>attr</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies the attribute whose values are desired.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Array of Values</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>The <strong>ldap_get_values()</strong> API will return NULL and set the <em>
|
||
|
|
ld_errno</em> error code, if not successful. See <a href=
|
||
|
|
"ldap_error_condt.htm">LDAP Client API Error Conditions</a> for possible LDAP
|
||
|
|
error code values.</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_get_values API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_get_values_len.htm">ldap_get_values_len()</a> -- Return an
|
||
|
|
attribute's binary values.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_count_value.htm">ldap_count_values()</a> -- Return number of
|
||
|
|
values.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_count_values_len.htm">ldap_count_values_len()</a> -- Return
|
||
|
|
number of binary values.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_value_free.htm">ldap_value_free()</a> -- Free memory
|
||
|
|
allocated by ldap_get_values().</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_value_free_len.htm">ldap_value_free_len()</a> -- Free memory
|
||
|
|
allocated by ldap_get_values_len().</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>
|
||
|
|
|