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

180 lines
4.6 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>ldap_version -- Obtain LDAP Version and SSL Cipher Information</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/20/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_version -- Obtain LDAP Version and SSL Cipher Information</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
#include &lt;ldapssl.h&gt;
int ldap_version(
LDAPVersion *<em>version</em> )
</pre>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library Name/Service Program: QSYS/QGLDCLNT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>ldap_version()</strong> routine is used to return the toolkit
version (multiplied by 100). It also sets information in the LDAPVersion
structure.</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt>version</dt>
<dd>(Input) Specifies the address of an LDAPVersion structure that contains the
following returned values:<br>
<br>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td width="15%" valign="top"><em>sdk_version</em></td>
<td width="85%" valign="top">Toolkit version, multiplied by 100.</td>
</tr>
<tr>
<td valign="top"><em>protocol_version</em></td>
<td valign="top">Highest LDAP protocol supported, multiplied by 100.</td>
</tr>
<tr>
<td valign="top"><em>SSL_version</em></td>
<td valign="top">SSL version supported, multiplied by 100.</td>
</tr>
<tr>
<td valign="top"><em>security_level</em></td>
<td valign="top">Level of encryption supported, in bits. Set to <strong>
LDAP_SECURITY_NONE</strong> if SSL not enabled.</td>
</tr>
<tr>
<td valign="top"><em>ssl_max_cipher</em></td>
<td valign="top">A string containing the default ordered set of ciphers
supported by this installation. See <a href="ldap_set_option.htm#cipher">
LDAP_OPT_SSL_CIPHER</a> in <strong>ldap_set_option()</strong> for more
information about changing the set of ciphers used to negotiate the secure
connection with the server.</td>
</tr>
<tr>
<td valign="top"><em>sdk_vendor</em></td>
<td valign="top">A pointer to a static string that identifies the supplier of
the LDAP library. This string should not be freed by the application.</td>
</tr>
<tr>
<td valign="top"><em>sdk_build_level</em></td>
<td valign="top">A pointer to a static string that identifies the build level,
including the date when the library was built. This string should not be freed
by the application.</td>
</tr>
</table>
<br>
</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>Software Developer Toolkit Version</strong></dt>
<dd>Sets information in the LDAPVersion structure and return the SDK
VERSION.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>The <strong>ldap_version()</strong> API does not return an error code.</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_version
API.</td>
</tr>
</table>
<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>