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

155 lines
3.8 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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_dn2ufn()--Convert a Distinguished Name into a User Friendly
Name</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/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_dn2ufn()--Convert a Distinguished Name into a User Friendly Name</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
char *ldap_dn2ufn(
const char *<em>dn</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_dn2ufn()</strong> function takes a distinguished name (DN)
and converts into a "friendlier" representation by removing the attribute type
that is associated with each relative distinguished name (RDN). For example,
the DN "cn=John Doe,ou=Widget Division,ou=Austin,o=IBM,c=US" would be returned
in its "friendlier" form as "John Doe, Widget Division, Austin, IBM, US". Space
for the user-friendly name will have been obtained by the API, and should be
freed by the caller with a call to <a href="ldap_memfree.htm">
ldap_memfree()</a>.</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><em>dn</em></dt>
<dd>(Input) Specifies the DN to be converted (as returned from <a href=
"ldap_get_dn.htm">ldap_get_dn()</a>).</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>Character String</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_dn2ufn()</strong> is not successful, then there was no
memory available for the character string.</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_dn2ufn
API.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="ldap_get_dn.htm">ldap_get_dn()</a> -- Extract the DN from an
entry.</li>
<li><a href="ldap_explode_rdn.htm">ldap_explode_rdn()</a> -- Break a Relative
Distinguished Name into Its Components.</li>
</ul>
<br>
<hr>
API introduced: V5R1
<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>