InfoDirectory使用手引書

5.2.1 API関数の一覧

　本ライブラリでサポートされているAPI関数は、正式なRFC1823をサポートして、かつドラフト“draft-ietf-ldapext-ldap-c-api-05.txt”に準拠しています。

　本ライブラリでは、これに加えて以下の機能が追加されています。

• SSL対応のAPI
• 日本語サポート機能

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

[表: API関数一覧]

分類	関数名	関数の説明	規約準拠	LDAP V2	LDAP V3
LDAP操作（オープン／クローズ）	ldap_init()	InfoDirectoryサーバへのセションを初期化します。	○	○	○
	ldapssl_init()	InfoDirectoryサーバへのセションを初期化します。（SSL使用）	×	○	○
	ldap_get_option()	セションハンドルオプションの設定値を参照します。	○	○	○
	ldap_set_option()	セションハンドルオプションを設定します。	○	○	○
	ldap_version()	ライブラリのバージョン情報を参照します。	○	○	○
	ldap_unbind()	InfoDirectoryサーバとのコネクションをクローズした後、セションを解放します。	○	○	○
	ldap_unbind_s()	ldap_unbind()と同じ処理を行います。	○	○	○
LDAP操作（ユーザ認証）	ldap_simple_bind()	InfoDirectoryサーバとの簡易認証を行います。 （非同期型）	○	○	○
	ldap_simple_bind_s()	InfoDirectoryサーバとの簡易認証を行います。 （同期型）	○	○	○
	ldap_sasl_bind()	InfoDirectoryサーバとの証明書ベースの認証を行います。 （非同期型）	○	×	○
	ldap_sasl_bind_s()	InfoDirectoryサーバとの証明書ベースの認証を行います。 （同期型）	○	×	○
LDAP操作（エントリ検索）	ldap_search()	指定された条件のエントリを検索します。 （非同期型）	○	○	○
	ldap_search_s()	指定された条件のエントリを検索します。 （同期型）	○	○	○
	ldap_search_st()	指定された条件のエントリを検索します。 （同期型、タイムアウトあり）	○	○	○
	ldap_search_ext()	指定された条件のエントリを検索します。 （非同期型、LDAPコントロール指定可能）	○	△ ※1	○
	ldap_search_ext_s()	指定された条件のエントリを検索します。 （同期型、LDAPコントロール指定可能）	○	△ ※1	○
LDAP操作（エントリ比較）	ldap_compare()	エントリの属性値を指定された値と比較します。 （非同期型）	○	○	○
	ldap_compare_s()	エントリの属性値を指定された値と比較します。 （同期型）	○	○	○
	ldap_compare_ext()	エントリの属性値を指定された値と比較します。 （非同期型、LDAPコントロール指定可能）	○	△ ※1	○
	ldap_compare_ext_s()	エントリの属性値を指定された値と比較します。 （同期型、LDAPコントロール指定可能）	○	△ ※1	○
LDAP操作（エントリ変更）	ldap_modify()	指定されたエントリを更新します。 （非同期型）	○	○	○
	ldap_modify_s()	指定されたエントリを更新します。 （同期型）	○	○	○
	ldap_modify_ext()	指定されたエントリを更新します。 (非同期型、LDAPコントロール指定可能)	○	△ ※1	○
	ldap_modify_ext_s()	指定されたエントリを更新します。 (同期型、LDAPコントロール指定可能)	○	△ ※1	○
LDAP操作（エントリの名前変更）	ldap_rename()	指定されたエントリのDNまたはRDNを変更します。 （非同期型、LDAPコントロール指定可能）	○	△ ※1	○
	ldap_rename_s()	指定されたエントリのDNまたはRDNを変更します。 （同期型、LDAPコントロール指定可能）	○	△ ※1	○
LDAP操作（エントリの追加）	ldap_add()	指定されたエントリを追加します。 （非同期型）	○	○	○
	ldap_add_s()	指定されたエントリを追加します。 （同期型）	○	○	○
	ldap_add_ext()	指定されたエントリを追加します。 (非同期型、LDAPコントロール指定可能)	○	△ ※1	○
	ldap_add_ext_s()	指定されたエントリを追加します。 (同期型、LDAPコントロール指定可能)	○	△ ※1	○
LDAP操作（エントリの削除）	ldap_delete()	指定されたエントリを削除します。 （非同期型）	○	○	○
	ldap_delete_s()	指定されたエントリを削除します。 （同期型）	○	○	○
	ldap_delete_ext()	指定されたエントリを削除します。 (非同期型、LDAPコントロール指定可能)	○	△ ※1	○
	ldap_delete_ext_s()	指定されたエントリを削除します。 (同期型、LDAPコントロール指定可能)	○	△ ※1	○
LDAP操作（LDAPプロトコル拡張）	ldap_extended_operation()	LDAPプロトコルを拡張します。 （非同期型）	○	×	○
	ldap_extended_operation_s()	LDAPプロトコルを拡張します。 （同期型）	○	×	○
LDAP操作（非同期処理の取消し）	ldap_abandon()	非同期処理を破棄(中断)します。 （取消すことができる非同期処理は、サーバのインプリメントに依存します。）	○	○	○
	ldap_abandon_ext()	非同期処理を破棄(中断)します。 （LDAPコントロール指定可能） （取消すことができる非同期処理は、サーバのインプリメントに依存します。）	○	△ ※1	○
処理結果の受取り／判定	ldap_result()	非同期処理の処理結果を待ち合わせます。	○	○	○
	ldap_msgid()	指定されたメッセージのメッセージIDを参照します。	○	○	○
	ldap_msgtype()	指定されたメッセージのタイプを参照します。	○	○	○
エラー情報の取得	ldap_parse_result()	指定されたresult情報のLDAPエラー情報を読込みます。	○	○	○
	ldap_parse_extended_result()	指定されたresult情報のLDAPエラー情報を読込みます。 （LDAPプロトコル拡張）	○	×	○
	ldap_err2string()	LDAPエラーコードを文字列に変換します。	○	○	○
	ldapssl_error()	SSLライブラリのエラーコードを読込みます。	×	○	○
メッセージリストの処理	ldap_first_message()	最初のメッセージのアドレスを返します。	○	○	○
	ldap_next_message()	次のメッセージのアドレスを返します。 （前回読込んだものに続くメッセージ）	○	○	○
	ldap_count_messages()	メッセージリストに含まれるメッセージの個数をカウントします。	○	○	○
リフェラル情報を含むメッセージの処理	ldap_first_reference()	指定されたメッセージの最初のリフェラル情報を含むメッセージを返します。	○	△ ※2	○
	ldap_next_reference()	指定されたメッセージの次のリフェラル情報を含むメッセージを返します。 （前回読込んだメッセージに続くリフェラル情報を含むメッセージ）	○	△ ※2	○
	ldap_count_reference()	指定されたメッセージに含まれるリフェラル情報を持つメッセージの数をカウントします。	○	△ ※2	○
エントリリストの処理	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()	読込んだ属性値の数をカウントします。 （属性値がバイナリデータの場合）	○	○	○
識別名の読込み／解析	ldap_get_dn()	指定されたエントリのDNを読込みます。	○	○	○
	ldap_explode_dn()	指定されたDNを、構成要素に分解します。	○	○	○
	ldap_explode_rdn()	指定されたRDNを構成要素に分解します。	○	○	○
	ldap_dn2ufn()	指定されたDNをユーザフレンドリな形式に変換します。	○	○	○
LDAPControl構造体の読込み	ldap_get_entry_controls()	指定されたエントリからLDAPコントロールの情報を取出します。	○	×	○
	ldap_parse_reference()	指定されたリフェラル情報を持つメッセージからリフェラル情報とLDAPコントロールの情報を取出します。	○	△ ※2	○
LDAPControl構造体の設定	ldap_create_paging_control()	LDAPControl構造体にページングの初期設定を行います。	×	△ ※2	○
	ldap_create_more_paging_control()	LDAPControl構造体に次のページング情報を取得できるように設定を行います。	×	△ ※2	○
	ldap_create_sort_control()	LDAPControl構造体にサーバソートの初期設定を行います。	×	△ ※2	○
動的メモリの解放	ber_bvfree()	指定されたberval構造体を解放します。	○	○	○
	ldap_ber_free()	指定されたBERエレメントを解放します。	○	○	○
	ldap_control_free()	LDAPコントロールを解放します。	○	△ ※2	○
	ldap_controls_free()	LDAPコントロールのポインタ配列を解放します。	○	△ ※2	○
	ldap_memfree()	LDAPのAPI関数が動的に獲得した領域を解放します。	○	○	○
	ldap_msgfree()	ldap_result()で通知されたメッセージリストを解放します。	○	○	○
	ldap_value_free()	文字列データのポインタ配列を解放します。	○	○	○
	ldap_value_free_len()	バイナリデータのポインタ配列を解放します。	○	○	○
エンコード／デコード	ldap_conv_utf()	日本語を含む文字列をUTF-8に変換します。	×	△ ※2	○
	ldap_conv_utf2()	日本語を含む文字列をUTF-8に変換します。	×	△ ※2	○
	ldap_conv_init()	ldap_conv_utf2の初期化を行います。	×	△ ※2	○
	ldap_conv_close()	ldap_conv_utf2の後処理を行います。	×	△ ※2	○

　※1　LDAP V3固有の機能は使用できません。
　　　（格納先のDNの指定は、LDAP V3のみ有効）

　※2　この関数の動作は、プロトコルのバージョンには依存しませんが、
　　　　LDAP V3固有の機能を使用するための機能を提供します。