Home > PHP > Function > LDAP > ldap_set_option()

ldap_set_option()

ldap_set_option - Set the value of the given option

Syntax

bool ldap_set_option (resource $link_identifier, int $option, mixed $newval)

Arguments

  • link_identifier - An LDAP link identifier, returned by ldap_connect().
  • option - The parameter option can be one of: Option Type Available since LDAP_OPT_DEREF integer   LDAP_OPT_SIZELIMIT integer   LDAP_OPT_TIMELIMIT integer   LDAP_OPT_NETWORK_TIMEOUT integer PHP 5.3.0 LDAP_OPT_PROTOCOL_VERSION integer   LDAP_OPT_ERROR_NUMBER integer   LDAP_OPT_REFERRALS bool   LDAP_OPT_RESTART bool   LDAP_OPT_HOST_NAME string   LDAP_OPT_ERROR_STRING string   LDAP_OPT_MATCHED_DN string   LDAP_OPT_SERVER_CONTROLS array   LDAP_OPT_CLIENT_CONTROLS array   LDAP_OPT_SERVER_CONTROLS and LDAP_OPT_CLIENT_CONTROLS require a list of controls, this means that the value must be an array of controls. A control consists of an oididentifying the control, an optional value, and an optional flag for criticality. In PHP a control is given by an array containing an element with the key oidand string value, and two optional elements. The optional elements are key valuewith string value and key iscriticalwith boolean value. iscriticaldefaults to FALSE if not supplied. See » draft-ietf-ldapext-ldap-c-api-xx.txtfor details. See also the second example below.
  • newval - The new value for the specified option.

Description

Sets the value of the specified option to be newval.

Version

PHP 4.0.4, 5

Return value

Returns TRUE on success or FALSE on failure.