JavaScript Editor Javascript debugger     Website design 

ldap_get_option

Get the current value for given option (PHP 4 >= 4.0.4, PHP 5)
bool ldap_get_option ( resource link_identifier, int option, mixed &retval )

Sets retval to the value of the specified option.

Parameters

link_identifier

An LDAP link identifier, returned by ldap_connect().

option

The parameter option can be one of:

OptionType 
LDAP_OPT_DEREFinteger 
LDAP_OPT_SIZELIMITinteger 
LDAP_OPT_TIMELIMITinteger 
LDAP_OPT_NETWORK_TIMEOUTinteger 
LDAP_OPT_PROTOCOL_VERSIONinteger 
LDAP_OPT_ERROR_NUMBERinteger 
LDAP_OPT_REFERRALSbool 
LDAP_OPT_RESTARTbool 
LDAP_OPT_HOST_NAMEstring 
LDAP_OPT_ERROR_STRINGstring 
LDAP_OPT_MATCHED_DNstring 
LDAP_OPT_SERVER_CONTROLSarray 
LDAP_OPT_CLIENT_CONTROLSarray 
retval

This will be set to the option value.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 1119. Check protocol version

<?php
// $ds is a valid link identifier for a directory server
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
   echo
"Using protocol version $version\n";
} else {
   echo
"Unable to determine protocol version\n";
}
?>


Notes

Note:

This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.