Interstage Application Server リファレンスマニュアル（API編）

1.21 Interstage ディレクトリサービスインタフェース

　ここでは、Interstage ディレクトリサービスのクライアントAPIの関数仕様について説明します。

　クライアントAPIライブラリでサポートしているAPI関数を、以下に示します。

分類	関数名	関数の説明	拡張関数
セションのオープンとクローズインタフェース	ldap_init()	リポジトリサーバへのセションを初期化します。
	ldapssl_init()	リポジトリサーバへのセションを初期化します。(SSL使用)
	ldap_unbind()	リポジトリサーバとのコネクションをクローズした後、セションを解放します。
	ldap_unbind_s()	ldap_unbind()と同じ処理をします。
セションハンドルオプションの設定/参照インタフェース	ldap_get_option()	セションハンドルオプションの設定値を参照します。
	ldap_set_option()	セションハンドルオプションを設定します。
リポジトリサーバとのユーザ認証インタフェース	ldap_simple_bind()	リポジトリサーバとの簡易認証をします。 （非同期型）
	ldap_simple_bind_s()	リポジトリサーバとの簡易認証をします。 （同期型）
エントリの検索インタフェース	ldap_search()	指定された条件のエントリを検索します。 （非同期型）
	ldap_search_s()	指定された条件のエントリを検索します。 （同期型）
	ldap_search_st()	指定された条件のエントリを検索します。 （同期型、時間制限付き）
	ldap_search_ext()	指定された条件のエントリを検索します。 （非同期型、LDAP V3拡張関数）
	ldap_search_ext_s()	指定された条件のエントリを検索します。 （同期型、LDAP V3拡張関数）
属性値の比較インタフェース	ldap_compare()	エントリの属性値を指定された値と比較します。 （非同期型）
	ldap_compare_s()	エントリの属性値を指定された値と比較します。 （同期型）
	ldap_compare_ext()	エントリの属性値を指定された値と比較します。 （非同期型、LDAP V3拡張関数）
	ldap_compare_ext_s()	エントリの属性値を指定された値と比較します。 （同期型、LDAP V3拡張関数）
エントリの変更インタフェース	ldap_modify()	指定されたエントリを更新します。 （非同期型）
	ldap_modify_s()	指定されたエントリを更新します。 （同期型）
	ldap_modify_ext()	指定されたエントリを更新します。 (非同期型、LDAP V3拡張関数)
	ldap_modify_ext_s()	指定されたエントリを更新します。 (同期型、LDAP V3拡張関数)
エントリ名の変更インタフェース	ldap_rename()	指定されたエントリのDN、またはRDNを変更します。 （非同期型、LDAP V3拡張関数）
	ldap_rename_s()	指定されたエントリのDN、またはRDNを変更します。 （同期型、LDAP V3拡張関数）
エントリの追加インタフェース	ldap_add()	指定されたエントリを追加します。 （非同期型）
	ldap_add_s()	指定されたエントリを追加します。 （同期型）
	ldap_add_ext()	指定されたエントリを追加します。 (非同期型、LDAP V3拡張関数)
	ldap_add_ext_s()	指定されたエントリを追加します。 (同期型、LDAP V3拡張関数)
エントリの削除インタフェース	ldap_delete()	指定されたエントリを削除します。 （非同期型）
	ldap_delete_s()	指定されたエントリを削除します。 （同期型）
	ldap_delete_ext()	指定されたエントリを削除します。 (非同期型、LDAP V3拡張関数)
	ldap_delete_ext_s()	指定されたエントリを削除します。 (同期型、LDAP V3拡張関数)
非同期処理の中止インタフェース	ldap_abandon()	非同期処理を破棄(中断)します。
	ldap_abandon_ext()	非同期処理を破棄(中断)します。 （LDAP V3拡張関数）
処理結果の受取り/解析インタフェース	ldap_result()	非同期関数の処理結果や検索結果のエントリを受け取ります。
	ldap_msgid()	指定されたメッセージのメッセージIDを参照します。
	ldap_msgtype()	指定されたメッセージのタイプを参照します。
エラー情報の取得インタフェース	ldap_parse_result()	指定されたresult情報のLDAPエラー情報を読み込みます。
	ldap_err2string()	LDAPエラーコードを文字列に変換します。
	ldapssl_error()	SSLライブラリのエラーコードを読み込みます。
メッセージリストの処理インタフェース	ldap_first_message()	最初のメッセージのアドレスを返します。
	ldap_next_message()	次のメッセージのアドレスを返します。 （前回読み込んだものに続くメッセージ）
	ldap_count_messages()	メッセージリストに含まれるメッセージの個数をカウントします。
エントリリストの処理インタフェース	ldap_first_entry()	指定されたメッセージの最初のエントリを返します。
	ldap_next_entry()	指定されたメッセージの次のエントリを返します。 （前回読み込んだものに続くエントリ）
	ldap_count_entries()	指定されたメッセージ内のエントリ数をカウントします。
属性名の読込みインタフェース	ldap_first_attribute()	指定されたエントリの最初の属性名を返します。
	ldap_next_attribute()	指定されたエントリの次の属性名を返します。 （前回読み込んだものに続く属性名）
属性値の読込みインタフェース	ldap_get_values()	指定された属性の属性値を読み込みます。 （属性値が文字列データの場合）
	ldap_get_values_len()	指定された属性の属性値を読み込みます。 （属性値がバイナリデータの場合）
	ldap_count_values()	読み込んだ属性値の数をカウントします。 （属性値が文字列データの場合）
	ldap_count_values_len()	読み込んだ属性値の数をカウントします。 （属性値がバイナリデータの場合）
DNの読込み/解析インタフェース	ldap_get_dn()	指定されたエントリのDNを読み込みます。
	ldap_explode_dn()	指定されたDNを、構成要素に分解します。
	ldap_explode_rdn()	指定されたRDNを構成要素に分解します。
	ldap_dn2ufn()	指定されたDNをユーザフレンドリな形式に変換します。
動的メモリの解放インタフェース	ber_free()	指定されたBerElement構造体を解放します。
	ldap_ber_free()	指定されたBerElement構造体を解放します。(推奨されません。)
	ldap_memfree()	LDAPのAPI関数が動的に獲得した領域を解放します。
	ldap_msgfree()	ldap_result()で通知されたメッセージリストを解放します。
	ldap_value_free()	文字列データのポインタ配列を解放します。
	ldap_value_free_len()	バイナリデータのポインタ配列を解放します。
コード変換インタフェース	ldap_conv_utf()	日本語を含む文字列を変換規則に従ってコード変換します。	○
	ldap_conv_utf2()	日本語を含む文字列を変換規則に従ってコード変換します。	○
	ldap_conv_init()	ldap_conv_utf2()の初期化をします。	○
	ldap_conv_close()	ldap_conv_utf2()の後処理をします。	○
バージョン情報参照インタフェース	ldap_version()	ライブラリのバージョン情報を参照します。

　Interstage ディレクトリサービスではLDAP V2プロトコルをサポートしていません。

---

1.21.1 セションのオープンとクローズインタフェース

1.21.2 セションハンドルオプションの設定/参照インタフェース

1.21.3 リポジトリサーバとのユーザ認証インタフェース

1.21.4 エントリの検索インタフェース

1.21.5 属性値の比較インタフェース

1.21.6 エントリの変更インタフェース

1.21.7 エントリ名の変更インタフェース

1.21.8 エントリの追加インタフェース

1.21.9 エントリの削除インタフェース

1.21.10 非同期処理の中止インタフェース

1.21.11 処理結果の受取り/解析インタフェース

1.21.12 検索結果の解析処理インタフェース

1.21.13 動的メモリの解放インタフェース

1.21.14 コード変換インタフェース

1.21.15 バージョン情報参照インタフェース

1.21.16 構造体の構成