<!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_bind_s()--Perform an LDAP Bind Request (Synchronous)</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 --> <!-- This file has undergone html cleanup on 2/18/02 by JET --> <!--File Edited March 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> <a name="Top_Of_Page"></a> <h2>ldap_bind_s()--Perform an LDAP Bind Request (Synchronous)</h2> <div class="box" style="width: 70%;"> <br> Syntax<br> <pre> #include <ldap.h> int ldap_bind_s( LDAP *<em>ld</em>, const char *<em>dn</em>, const char *<em>cred</em>, int <em>method</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_bind_s()</strong> function provide synchronous general authentication routines, where in principle an authentication method can be chosen. In this toolkit, method must be set to <strong> LDAP_AUTH_SIMPLE</strong>.</p> <p>The <strong>ldap_bind_s()</strong> function is used to authenticate a distinguished name (DN) to a directory server. When connecting to an LDAP V2 server, after a connection is made by using the <strong>ldap_open()</strong> API, an LDAP bind API must be called before any other LDAP APIs can be called for that connection. Binding the connection is not required for LDAP V3.</p> <p><strong>ldap_bind_s()</strong> is synchronous request.</p> <p>Since this APIs is deprecated, <a href="ldap_simple_bind_s.htm"> ldap_simple_bind_s()</a> should be used instead.</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 distinguished name of the entry to bind as.<br><br></dd> <dt><strong><em>cred</em></strong></dt> <dd>(Input) The credentials with which to authenticate. Arbitrary credentials can be passed using this parameter. In most cases, this is the user's password.<br><br></dd> <dt><strong><em>method</em></strong></dt> <dd>(Input) Selects the authentication method to use. Specify <strong> LDAP_AUTH_SIMPLE</strong> for simple authentication. Simple authentication is the only supported method.</dd> </dl> <p>Note that use of the <strong>ldap_bind_s()</strong> APIs is deprecated.</p> <br> <h3>Return Value</h3> <dl> <dt><strong>LDAP_SUCCESS</strong></dt> <dd>if the request was successful.<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>The <strong>ldap_bind_s()</strong> API will return an LDAP error code if not successful. 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 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_bind_s API.</td> </tr> </table> <br> <br> <h3>Related Information</h3> <ul> <li><a href="ldap_bind.htm">ldap_bind()</a> -- Asynchronously bind to the directory (deprecated).</li> <li><a href="ldap_sasl_bind.htm">ldap_sasl_bind()</a> -- Asynchronously bind to the directory using SASL.</li> <li><a href="ldap_sasl_bind_s.htm">ldap_sasl_bind_s()</a> -- Synchronously bind to the directory using SASL.</li> <li><a href="ldap_simple_bind.htm">ldap_simple_bind()</a> -- Asynchronously bind to the directory using simple authentication.</li> <li><a href="ldap_simple_bind_s.htm">ldap_simple_bind_s()</a> -- Synchronously bind to the directory using simple authentication.</li> <li><a href="ldap_unbind.htm">ldap_unbind()</a> -- Asynchronously unbind from the LDAP server and close the connection.</li> <li><a href="ldap_unbind_s.htm">ldap_unbind_s()</a> -- Synchronously unbind from the LDAP server and close the connection.</li> <li><a href="ldap_set_rebind_proc.htm">ldap_set_rebind_proc()</a> -- Sets the entry-point of a routine during the chasing of referrals.</li> </ul> <br> <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>