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

関数名	関数の説明
ldap_compare()	エントリの属性値を指定された値と比較します。（非同期型）
ldap_compare_s()	エントリの属性値を指定された値と比較します。（同期型）
ldap_compare_ext()	エントリの属性値を指定された値と比較します。（非同期型、LDAP V3拡張関数）
ldap_compare_ext_s()	エントリの属性値を指定された値と比較します。（同期型、LDAP V3拡張関数）

1.20.5.1 ldap_compare()

名前

ldap_compare

形式

  #include "idldap.h"
  int  ldap_compare(
          LDAP  *ld,
          const char  *dn,
          const char  *attr,
          const char  *value );

機能説明

この関数は、非同期型の属性値比較処理をします。バイナリデータの比較はできません。

非同期型検索の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_compare()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 比較するエントリのDNのアドレスを指定します。

attr: 比較する属性の名前のアドレスを指定します。

value: 比較対象の文字列データのアドレスを指定します。

復帰値

この関数は、復帰値として以下の値を返します。

正常終了の場合：メッセージID
異常終了の場合： -1
異常終了の場合のエラー原因は、ldap_get_option()のLDAP_OPT_RESULT_CODEオプションで参照してください。

1.20.5.2 ldap_compare_s()

名前

ldap_compare_s

形式

  #include "idldap.h"
  int  ldap_compare_s(
          LDAP  *ld,
          const char  *dn,
          const char  *attr,
          const char  *value );

機能説明

この関数は、同期型の属性値比較処理をします。バイナリデータの比較はできません。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 比較するエントリのDNのアドレスを指定します。

attr: 比較する属性の名前のアドレスを指定します。

value: 比較対象の文字列データのアドレスを指定します。

復帰値

この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“メッセージ集”の“LDAPエラーコード”を参照してください。

LDAP_COMPARE_TRUE（正常終了）の場合：指定された属性に、valueパラメタで指定された値が含まれています。
LDAP_COMPARE_FALSE（正常終了）の場合：指定された属性に、valueパラメタで指定された値が含まれていません。
異常終了の場合：上記以外のLDAPエラーコードが通知されます。

1.20.5.3 ldap_compare_ext()

名前

ldap_compare_ext

形式

  #include "idldap.h"
  int  ldap_compare_ext(
          LDAP  *ld,
          const char  *dn,
          const char  *attr,
          const struct berval  *bvalue,
          LDAPControl  **serverctrls,
          LDAPControl  **clientctrls,
          int  *msgidp );

機能説明

この関数は、非同期型の属性値比較処理をします。バイナリデータの比較はできません。

非同期型検索の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_compare_ext()の復帰値として通知されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 比較するエントリのDNのアドレスを指定します。

attr: 比較する属性の名前のアドレスを指定します。

bvalue: 比較対象のデータを設定したberval構造体のアドレスを指定します。

serverctrls: Interstage ディレクトリサービスではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

clientctrls: 本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

msgidp: メッセージIDを格納するための変数のアドレスを指定します。

復帰値

正常終了の場合： LDAP_SUCCESS
異常終了の場合： LDAP_SUCCESS以外のLDAPエラーコード

また、正常終了の場合には、msgidpパラメタで指定した変数にメッセージIDが設定されています。

1.20.5.4 ldap_compare_ext_s()

名前

ldap_compare_ext_s

形式

  #include "idldap.h"
  int  ldap_compare_ext_s(
          LDAP  *ld,
          const char  *dn,
          const char  *attr,
          const struct berval  *bvalue,
          LDAPControl  **serverctrls,
          LDAPControl  **clientctrls );

機能説明

この関数は、同期型の属性値比較処理をします。バイナリデータの比較はできません。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 比較するエントリのDNのアドレスを指定します。

attr: 比較する属性の名前のアドレスを指定します。

bvalue: 比較対象のデータを設定したberval構造体のアドレスを指定します。

serverctrls: Interstage ディレクトリサービスではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

clientctrls: 本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

復帰値

LDAP_COMPARE_TRUE（正常終了）の場合：指定された属性に、bvalueパラメタで指定された値が含まれています。
LDAP_COMPARE_FALSE（正常終了）の場合：指定された属性に、bvalueパラメタで指定された値が含まれていません。
異常終了の場合：上記以外のLDAPエラーコードが通知されます。