Interstage Application Server Smart Repository運用ガイド

6.2.3.1 セションハンドルオプション

　クライアントAPIライブラリでは、セションごとの動作環境を、セションハンドルオプションとして設定／参照することができます。
　使用可能なセションハンドルオプションを、以下に示します。

オプションのタイプ	optdataの形式	optdataが示す領域の値（値の意味）	set	get
LDAP_OPT_DESC （ソケット識別子の参照）	int *	使用中のソケット識別子 　（設定不可）	×	○
LDAP_OPT_DEREF （別名参照ルール）	int *	LDAP_DEREF_NEVER（初期値） 　別名を参照しません。	○	○
		LDAP_DEREF_FINDING 　サーチベースを探す時のみ別名を参照します。 　（検索の際には別名を参照しません。）
		LDAP_DEREF_SEARCHING 　検索時のみ別名を参照します。 　（サーチベースを探している時は、別名を参照しません。
		LDAP_DEREF_ALWAYS 　別名を参照します。
LDAP_OPT_SIZELIMIT （リポジトリサーバが送信する最大エントリ数）(注)	int *	LDAP_NO_LIMIT（初期値） 　リポジトリサーバが送信する最大エントリ数を制限しません。	○	○
		受信可能なエントリ数 　指定された値が、サーバが送信する最大エントリ数となります。
LDAP_OPT_TIMELIMIT （リポジトリサーバでの最大検索時間）(注)	int *	LDAP_NO_LIMIT（初期値） 　リポジトリサーバでの検索時間を制限しません。	○	○
		最大検索時間(秒単位) 　指定された値がサーバでの最大検索時間(秒単位)となります。
LDAP_OPT_RESTART （割込み発生時の継続動作）	void *	LDAP_OPT_ON 　SIGNALによる割込みが発生した場合に、ライブラリ内部でリカバリを行います。	○	○
		LDAP_OPT_OFF（初期値） 　SIGNALによる割込みが発生した場合に、ライブラリ内部でリカバリを行いません。 　（呼出し元にはエラーで復帰します）
LDAP_OPT_PROTOCOL_VERSION （使用するLDAPプロトコル）	int *	LDAP_VERSION2（初期値） 　LDAP V2プロトコルを使用します。	○	○
		LDAP_VERSION3 　LDAP V3プロトコルを使用します。
LDAP_OPT_SERVER_CONTROLS （サーバコントロールの省略値）	LDAPControl ***	デフォルトのサーバコントロールの、ポインタ配列のアドレス 　（LDAP V3プロトコルの場合に有効）	○	○
LDAP_OPT_HOST_NAME （デフォルトのホスト名）	char **	リポジトリサーバのホスト名 　ここで指定された名前が、デフォルトのホスト名となります。	○	○
LDAP_OPT_ERROR_NUMBER （LDAPエラーコードの読込み）	int *	最新のLDAPエラー番号 　（設定不可）	×	○
LDAP_OPT_ERROR_STRING （LDAPエラーメッセージの読込み）	char **	最新のLDAPエラーメッセージのアドレス 　（設定不可）	×	○
LDAP_OPT_CONNTIME （connect時のタイムアウトまでの最大待ち時間）	int *	LDAP_NO_LIMIT 　リポジトリサーバからの応答があるまで待ちます。	○	○
		タイムアウトまでの待ち時間 　指定された値がconnectにおけるサーバからの応答の最大待ち時間(秒単位)となります。初期値は、connectのタイムアウトの時間に依存します。SSL使用時には、この設定は使用できません。
LDAP_OPT_WSINIT （Windows Sockets DLLの初期化および終了処理の実施）	int *	LDAP_NO_WSINIT 　LDAP-APIでのWindows Sockets DLLの初期化および終了処理を行わないようにします。初期設定は、初期化および終了処理を行います。	○	○

　set ： ldap_set_option()
　get ： ldap_get_option()
　○ ： 使用可
　× ： 使用不可

(注)リポジトリにアクセスするDN(バインドDN)と、サーバ側の検索可能最大エントリ数、検索タイムアウト時間の設定値により、LDAP_OPT_SIZELIMITとLDAP_OPT_TIMELIMITの値が有効にならない場合があります。詳細は、“検索可能最大エントリ数、検索タイムアウト時間指定時の動作について”を参照してください。