ldap_get_option

(PHP 4 >= 4.0.4, PHP 5)

ldap_get_option -- 指定したオプションの現在の値を得る

説明

bool ldap_get_option ( resource link_identifier, int option, mixed &retval )

retval を、指定したオプションの値として設定します。

パラメータ

link_identifier

ldap_connect() が返す LDAP リンク ID。

option

パラメータ option は以下のいずれかとなります。

オプション 
LDAP_OPT_DEREFinteger 
LDAP_OPT_SIZELIMITinteger 
LDAP_OPT_TIMELIMITinteger 
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

これが、オプションの値として設定されます。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例 1. プロトコルのバージョンを調べる

<?php
// $ds はディレクトリサーバへの有効なリンクIDです
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
    echo
"使用中のプロトコルのバージョン: $version\n";
} else {
    echo
"プロトコルのバージョンを決定することができません\n";
}
?>

注意

注意: この関数は、OpenLDAP 2.x.x または Netscape Directory SDK x.x を使用した場合にのみ利用可能です。

参考

ldap_set_option()