指定したオプションの値を
newval
に設定し、 成功時に
TRUE
、エラーの場合に
FALSE
を返します。
パラメータ
option
は次のどれかになります。 LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT,
LDAP_OPT_TIMELIMIT, LDAP_OPT_PROTOCOL_VERSION,
LDAP_OPT_ERROR_NUMBER, LDAP_OPT_REFERRALS, LDAP_OPT_RESTART,
LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING, LDAP_OPT_MATCHED_DN,
LDAP_OPT_SERVER_CONTROLS, LDAP_OPT_CLIENT_CONTROLS
以下に簡単に説明しますが、詳細については、
draft-ietf-ldapext-ldap-c-api-xx.txt
を参照下さい。
オプション
LDAP_OPT_DEREF、LDAP_OPT_SIZELIMIT、LDAP_OPT_TIMELIMIT、
LDAP_OPT_PROTOCOL_VERSION、LDAP_OPT_ERROR_NUMBER は整数値であり、
LDAP_OPT_REFERRALS、LDAP_OPT_RESTART は論理値、オプション
LDAP_OPT_HOST_NAME、LDAP_OPT_ERROR_STRING、LDAP_OPT_MATCHED_DN の
値は文字列です。最初の例でこれらの使用方法を説明します。オプショ ン
LDAP_OPT_SERVER_CONTROLS、LDAP_OPT_CLIENT_CONTROLS はコントロー
ルのリストを必要とします。これは、値がコントロールの配列である必
要があることを意味します。コントロールは、そのコントロールのIDで ある
oid
、オプションの
value
、オプションのフラグ
criticality
からなります。PHPにおいてコント ロールは、キーが
oid
で値が文字列、二つのオ プションの要素からなる配列で指定されます。オプションの要素は、キー が
value
で値が文字列、キーが
iscritical
で値が論理値です。
iscritical
が指定されない場合のデフォルト値 は
FALSE
です。以下の2番目の例も参照下さい。
この関数は、OpenLDAP 2.x.x または Netscape Directory SDK
x.x を使 用している場合のみ利用可能で、PHP 4.0.4で追加されました。
ldap_get_option()
も参照下さい。