210 lines
5.8 KiB
HTML
210 lines
5.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_modrdn()--Perform an LDAP Modify RDN Request</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_modrdn()--Perform an LDAP Modify RDN Request</h2>
|
|
|
|
<br>
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
int ldap_modrdn(
|
|
LDAP *<em>ld</em>,
|
|
const char *<em>dn</em>,
|
|
const char *<em>newrdn</em>,
|
|
int <em>deleteoldrdn</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_modrdn()</strong> function is used to perform an LDAP
|
|
modify relative distinguished name (RDN) operation. The function takes the
|
|
distinguished name of the entry whose RDN is to be changed, and <em>
|
|
newrdn</em>, the new RDN to give the entry. The <em>deleteoldrdn</em> parameter
|
|
is used as a boolean value to indicate whether the old RDN values should be
|
|
deleted from the entry or not.</p>
|
|
|
|
<p><strong>ldap_modrdn()</strong> performs an asynchronous request. The result
|
|
of the operation can be obtained by a subsequent call to <a href=
|
|
"ldap_result.htm">ldap_result()</a>.</p>
|
|
|
|
<p>In LDAP V2, the <strong>ldap_modrdn()</strong> and <a href=
|
|
"ldap_modrdn_s.htm">ldap_modrdn_s()</a> APIs were used to change the name of an
|
|
LDAP entry. They could only be used to change the least significant component
|
|
of a name (the RDN or relative distinguished name). LDAP V3 provides the Modify
|
|
DN protocol operation that allows more general name change access. The <a href=
|
|
"ldap_rename.htm">ldap_rename()</a> and <a href="ldap_rename_s.htm">
|
|
ldap_rename_s()</a> routines are used to change the name of an entry, and the
|
|
use of the <strong>ldap_modrdn()</strong> and <a href="ldap_modrdn_s.htm">
|
|
ldap_modrdn_s()</a> routines are 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>
|
|
<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>.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>dn</em></dt>
|
|
|
|
<dd>(Input) Specifies the DN of the entry whose RDN is to be changed.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>newrdn</em></dt>
|
|
|
|
<dd>(Input) Specifies the new RDN to be given to the entry.<br>
|
|
<br>
|
|
</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.<br>
|
|
<br>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Message ID of the Operation Initiated</strong></dt>
|
|
|
|
<dd>if the request was successful. A subsequent call to <a href=
|
|
"ldap_result.htm">ldap_result()</a>, can be used to obtain the result of the
|
|
modify.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>-1</strong></dt>
|
|
|
|
<dd>if the request was not successful.<br>
|
|
<br>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>ldap_modrdn()</strong> is not successful, <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 the <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 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_modrdn
|
|
API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_add.htm">ldap_add()</a> -- Perform an LDAP add
|
|
operation.</li>
|
|
|
|
<li><a href="ldap_delete.htm">ldap_delete()</a> -- Perform an LDAP delete
|
|
operation.</li>
|
|
|
|
<li><a href="ldap_modify.htm">ldap_modify()</a> -- Asynchronous modify to a
|
|
directory entry.</li>
|
|
|
|
<li><a href="ldap_modrdn_s.htm">ldap_modrdn_s()</a> -- Synchronously modify the
|
|
RDN of an entry.</li>
|
|
|
|
<li><a href="ldap_rename.htm">ldap_rename()</a> -- Asynchronously rename an
|
|
entry.</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>
|
|
|