ldap_get_option
ldap_get_option
(PHP 4 >= 4.0.4, PHP 5, PHP 7)
ldap_get_option — Get the current value for given option
Description
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
optioncan be one of:Option Type 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 LDAP_OPT_X_KEEPALIVE_IDLEint LDAP_OPT_X_KEEPALIVE_PROBESint LDAP_OPT_X_KEEPALIVE_INTERVALint LDAP_OPT_X_TLS_CACERTDIRstring LDAP_OPT_X_TLS_CACERTFILEstring LDAP_OPT_X_TLS_CERTFILEstring LDAP_OPT_X_TLS_CIPHER_SUITEstring LDAP_OPT_X_TLS_CRLCHECKinteger LDAP_OPT_X_TLS_CRLFILEstring LDAP_OPT_X_TLS_DHFILEstring LDAP_OPT_X_TLS_KEYILEstring LDAP_OPT_X_TLS_PACKAGEstring LDAP_OPT_X_TLS_PROTOCOL_MINinteger LDAP_OPT_X_TLS_RANDOM_FILEstring LDAP_OPT_X_TLS_REQUIRE_CERTinteger -
retval -
This will be set to the option value.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example #1 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.
See Also
- ldap_set_option() - Set the value of the given option
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.ldap-get-option.php
