172 lines
4.6 KiB
HTML
172 lines
4.6 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_explode_dn()--Break a Distinguished Name into Its
|
||
|
|
Components</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_explode_dn()--Break a Distinguished Name into Its Components</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
char **ldap_explode_dn(
|
||
|
|
const char *<em>dn</em>,
|
||
|
|
int <em>notypes</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_explode_dn()</strong> function uses the distinguished name
|
||
|
|
in local codepage returned by <a href="ldap_get_dn.htm">ldap_get_dn()</a> and
|
||
|
|
breaks it up into its component parts. Each part is known as a Relative
|
||
|
|
Distinguished Name (RDN). If the dn is in UTF8, use <a href=
|
||
|
|
"ldap_explode_dn_utf8.htm">ldap_explode_dn_utf8()</a>.</p>
|
||
|
|
|
||
|
|
<p><strong>ldap_explode_dn()</strong> returns a NULL-terminated array, each
|
||
|
|
component of which contains an RDN from the DN. The <em>notypes</em> parameter
|
||
|
|
is used to request that only the RDN values be returned, not their types.</p>
|
||
|
|
|
||
|
|
<p>For example, the distinguished name cn=Bob,c=US would return as either
|
||
|
|
"cn=Bob","c=US",NULL or "Bob","US", NULL depending on whether <em>notypes</em>
|
||
|
|
was 0 or 1, respectively. The result can be freed by calling <a href=
|
||
|
|
"ldap_value_free.htm">ldap_value_free()</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 exploded (as returned from <a href=
|
||
|
|
"ldap_get_dn.htm">ldap_get_dn()</a>).</dd>
|
||
|
|
|
||
|
|
<dt><em>notypes</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies if type information is to be returned with each RDN. If
|
||
|
|
non-zero, the type information will be stripped. If zero, the type information
|
||
|
|
is retained. For example, setting <em>notypes</em> to 1 would result in the RDN
|
||
|
|
"cn=Fido" being returned as "Fido".</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Relative Distinguished Name (RDN)</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_explode_dn()</strong> is not successful, then there was no
|
||
|
|
memory available for either the array or its component parts.</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_explode_dn 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_dn_utf8.htm">ldap_explode_dn_utf8()</a> -- Break a
|
||
|
|
UTF8 Distinguided Name into its components.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_explode_rdn.htm">ldap_explode_rdn()</a> -- Break a Relative
|
||
|
|
Distinguished Name into its components.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|