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

83 lines
3.0 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>Controls for LDAP APIs</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 -->
<!--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>
<h2>Controls for LDAP APIs</h2>
<p>Certain LDAP Version 3 operations can be extended with the use of controls.
Controls can be sent to a server, or returned to the client with any LDAP
message. This type of control is called a server control.</p>
<p>The LDAP API also supports a client-side extension mechanism, which can be
used to define client controls. The client-side controls affect the behavior of
the LDAP client library, and are never sent to the server. Note that
client-side controls are not defined for this client library.</p>
<p>A common data structure is used to represent both server-side and
client-side controls:</p>
<pre>
typedef struct ldapcontrol {
char *ldctl_oid;
struct berval ldctl_value;
char ldctl_iscritical;
} LDAPControl, *PLDAPControl;
</pre>
<p>The LDAPControl fields have the following definitions:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><strong><em>ldctl_oid</em></strong></td>
<td align="left" valign="top">The control type, represented as a string.</td>
</tr>
<tr>
<td align="left" valign="top"><strong><em>ldctl_value</em></strong></td>
<td align="left" valign="top">The data associated with the control. Note that
the control may not include data.</td>
</tr>
<tr>
<td align="left" valign="top"><strong><em>ldctl_iscritical</em></strong></td>
<td align="left" valign="top">Whether the control is critical. If the field is
nonzero, the operation will be carried out only if it is recognized and
supported by the server (or the client for client-side controls).</td>
</tr>
</table>
<br>
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="dirserv1.htm">Directory Services
APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>