221 lines
6.6 KiB
HTML
221 lines
6.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_rename()--Asynchronously Rename 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_rename()--Asynchronously Rename an Entry</h2>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
int ldap_rename(
|
||
|
|
LDAP *<em>ld</em>,
|
||
|
|
const char *<em>dn</em>,
|
||
|
|
const char *<em>newrdn</em>,
|
||
|
|
const char *<em>newparent</em>,
|
||
|
|
int <em>deleteoldrdn</em>,
|
||
|
|
LDAPControl **<em>serverctrls</em>,
|
||
|
|
LDAPControl **<em>clientctrls</em>,
|
||
|
|
int *<em>msgidp</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_rename()</strong> routine initiates an asynchronous modify
|
||
|
|
DN operation</p>
|
||
|
|
|
||
|
|
<p>In LDAP version 2, the <a href="ldap_modrdn.htm">ldap_modrdn()</a> API was
|
||
|
|
used to change the name of an LDAP entry. It could only be used to change the
|
||
|
|
least significant component of a name (the RDN or relative distinguished name).
|
||
|
|
The LDAP version 3 protocol provides the Modify DN protocol operation that
|
||
|
|
allows more general name change access. The <strong>ldap_rename()</strong>
|
||
|
|
routine is used to change the name of an entry. The <strong>
|
||
|
|
ldap_modrdn()</strong> routine is deprecated.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>No i5/OS authority is required. All authority checking is done by the LDAP
|
||
|
|
server.</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>dn</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies the DN of the entry whose DN is to be changed.</dd>
|
||
|
|
|
||
|
|
<dt><em>newrdn</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies the new RDN to be given to the entry.</dd>
|
||
|
|
|
||
|
|
<dt><em>newparent</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies the new parent, or superior entry. If this parameter is
|
||
|
|
NULL, only the RDN of the entry is changed. The root DN may be specified by
|
||
|
|
passing a zero length string, "". The newparent parameter should always be NULL
|
||
|
|
when using version 2 of the LDAP protocol; otherwise the server's behavior is
|
||
|
|
undefined.</dd>
|
||
|
|
|
||
|
|
<dt><em>deleteoldrdn</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies a boolean value. When set to 1, the old RDN value is to
|
||
|
|
be deleted from the entry. When set to 0, the old RDN value should be retained
|
||
|
|
as a non-distinguished value. This parameter only has meaning if <em>
|
||
|
|
newrdn</em> is different from the old RDN.</dd>
|
||
|
|
|
||
|
|
<dt><em>serverctrls</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies a list of LDAP server controls. This parameter may be set
|
||
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
||
|
|
about server controls.</dd>
|
||
|
|
|
||
|
|
<dt><em>clientctrls</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies a list of LDAP client controls. This parameter may be set
|
||
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
||
|
|
about client controls.</dd>
|
||
|
|
|
||
|
|
<dt><em>msgidp</em></dt>
|
||
|
|
|
||
|
|
<dd>(Output) This result parameter is set to the message id of the request if
|
||
|
|
the <strong>ldap_rename()</strong> call succeeds.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the request was successfully sent. <strong>ldap_rename()</strong> places
|
||
|
|
the message id of the request in *<em>msgidp</em>. A subsequent call to <a
|
||
|
|
href="ldap_result.htm">ldap_result()</a> can be used to obtain the result of
|
||
|
|
the operation. Once the operation has completed, <strong>ldap_result()</strong>
|
||
|
|
returns a result that contains the status of the operation (in the form of an
|
||
|
|
error code). The error code indicates if the operation completed successfully.
|
||
|
|
The <a href="ldap_parse_result.htm">ldap_parse_result()</a> API is used to
|
||
|
|
check the error code in the result.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>another LDAP error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>in case of an error.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p>If <strong>ldap_rename()</strong> is not successful, an error code will be
|
||
|
|
returned. 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_rename
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_rename_s.htm">ldap_rename_s()</a> -- Synchronously rename an
|
||
|
|
entry.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_result.htm">ldap_result()</a> -- Retrieve result of an
|
||
|
|
asynchronous LDAP operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_modrdn.htm">ldap_modrdn()</a> -- Asynchronously modify the
|
||
|
|
RDN of an entry (deprecated).</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_modrdn_s.htm">ldap_modrdn_s()</a> -- Synchronously modify the
|
||
|
|
RDN of an entry (deprecated).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_rename()</strong> API supports LDAP V3 server controls and
|
||
|
|
client controls.</p>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|