198 lines
5.7 KiB
HTML
198 lines
5.7 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_add_ext()--Perform an LDAP Add Operation with Controls</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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>ldap_add_ext()--Perform an LDAP Add Operation with Controls</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
int ldap_add_ext(
|
|
LDAP *<em>ld</em>,
|
|
const char *<em>dn</em>,
|
|
LDAPMod **<em>attrs</em>,
|
|
LDAPControl **<em>serverctrls</em>,
|
|
LDAPControl **<em>clientctrls</em>,
|
|
int *<em>msgidp</em>)
|
|
</pre>
|
|
|
|
<br>
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>ldap_add_ext()</strong> function is used to perform an LDAP add
|
|
operation with controls.</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><strong><em>ld</em></strong></dt>
|
|
|
|
<dd>(Input) 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><strong><em>dn</em></strong></dt>
|
|
|
|
<dd>(Input) The DN of the entry to add.<br><br></dd>
|
|
|
|
<dt><strong><em>attrs</em></strong></dt>
|
|
|
|
<dd>(Input) The entry's attributes, specified using the LDAPMod structure, as
|
|
defined for <a href="ldap_modify.htm">ldap_modify()</a>. The <em>mod_type</em>
|
|
and <em>mod_vals</em> fields should be filled in. The <em>mod_op</em> field is
|
|
ignored unless ORed with the constant <strong>LDAP_MOD_BVALUES</strong>. In
|
|
this case, the <em>mod_op</em> field is used to select the <em>mod_bvalues</em>
|
|
case of the mod_vals union.<br><br></dd>
|
|
|
|
<dt><strong><em>serverctrls</em></strong></dt>
|
|
|
|
<dd>(Input) 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.<br><br></dd>
|
|
|
|
<dt><strong><em>clientctrls</em></strong></dt>
|
|
|
|
<dd>(Input) 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.<br><br></dd>
|
|
|
|
<dt><strong><em>msgidp</em></strong></dt>
|
|
|
|
<dd>(Output) This result parameter is set to the message ID of the request if
|
|
the <strong>ldap_add_ext()</strong> call succeeds.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
|
|
|
<dd>if the request was successful. If successful, <strong>
|
|
ldap_add_ext()</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.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>another LDAP error code</strong></dt>
|
|
|
|
<dd>if the request was not successful.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>ldap_add_ext()</strong> is not successful, an LDAP error code
|
|
will be returned. See <a href="ldap_error_condt.htm">LDAP Client API Error
|
|
Conditions</a> for possible LDAP error code values. 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.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>The following message may be sent from this function.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of ldap_add_ext
|
|
API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_add.htm">ldap_add()</a> -- Asynchronously add an entry.</li>
|
|
|
|
<li><a href="ldap_add_s.htm">ldap_add_s()</a> -- Synchronously add an
|
|
entry.</li>
|
|
|
|
<li><a href="ldap_add_ext_s.htm">ldap_add_ext_s()</a> -- Synchronously add an
|
|
entry with controls.</li>
|
|
|
|
<li><a href="ldap_modify_ext.htm">ldap_modify_ext()</a> -- Asynchronously
|
|
modify an entry with controls.</li>
|
|
</ul>
|
|
|
|
<p>The <strong>ldap_add_ext()</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>
|