ldap_get_bind_controls()--Get LDAP Bind Controls

Syntax

 #include <ldap.h>

 int ldap_get_bind_controls(
                LDAP                 *ld,
                LDAPControl         ***bind_controls)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_get_bind_controls() function allows a client using Simple Authentication Security Layer (SASL) binds to access controls returned by the server during a previous bind request. For example, this API could be used to get password policy response controls from a bind request (see ldap_parse_pwdpolicy_response()).

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld: (Input) The LDAP pointer used in a previous call to ldap_sasl_bind_s(). Must not be NULL.
bind_controls: (Output) On return, bind_controls will point to a NULL-terminated array of LDAPControl structures, or NULL if no controls were returned by the server. The caller must free the returned controls by using ldap_controls_free().

Return Value

LDAP_SUCCESS: if the request was successful.
LDAP_NO_MEMORY: if a memory allocation error occurred.
LDAP_PARAM_ERROR: if ld or bind_controls are NULL.

Related Information

ldap_controls_free -- Free an array of LDAPControl structures.
ldap_parse_pwdpolicy_response -- Obtain Error and Warning Codes from the Password Policy Response Control.
ldap_sasl_bind_s -- Perform an LDAP SASL Bind Request.

API introduced: V5R4

[ Back to top | LDAP APIs | APIs by category ]