5.2.4 属性値の比較

Interstage Application Server Smart Repository運用ガイド

目次索引

5.2.4 属性値の比較

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

ldap_compare

　この関数は、非同期型の属性値比較処理を行います。ldap_compare()では、バイナリ値の比較はできません。

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　比較を行うエントリのDNのアドレスを指定します。
attr
　比較を行う属性の名前のアドレスを指定します。
value
　比較対象の文字列データのアドレスを指定します。

【復帰値】

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

正常完了の場合：メッセージID
異常完了の場合： -1
　異常完了の場合、以下の原因が考えられます。
- パラメタの指定に誤りがあります。
- 使用可能なメモリが不足しました。

ldap_compare_s

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　比較を行うDNのアドレスを指定します。
attr
　比較を行う属性の名前のアドレスを指定します。
value
　比較対象の文字列データのアドレスを指定します。

【復帰値】

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

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

ldap_compare_ext

　この関数は、非同期型の属性値比較処理を行います。ldap_compare_ext()では、文字列データとバイナリデータの比較を行うことができます。

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　比較を行うDNのアドレスを指定します。
attr
　比較を行う属性の名前のアドレスを指定します。
bvalue
　比較対象のデータを設定したberval構造体のアドレスを指定します。
serverctrls
　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
clientctrls
本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。
msgidp
　メッセージIDを格納するための変数のアドレスを指定します。

【復帰値】

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

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

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

ldap_compare_ext_s

　この関数は、同期型の属性値比較処理を行います。ldap_compare_ext_s()では、文字列データとバイナリデータの比較を行うことができます。

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　比較を行うDNのアドレスを指定します。
attr
　比較を行う属性の名前のアドレスを指定します。
bvalue
　比較対象のデータを設定したberval構造体のアドレスを指定します。
serverctrls
　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
clientctrls
　本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

【復帰値】

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

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

目次索引