Interstage Application Server Smart Repository運用ガイド

5.2.11 検索結果の解析処理

エントリリストの処理

関数名	関数の説明
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をユーザフレンドリな形式に変換します。

 

ldap_first_entry

　この関数は、指定されたメッセージに含まれている、先頭のエントリのアドレスを通知します。

　ldap_first_entry()で通知されたエントリのアドレスは、以下の関数においてパラメタとして使用することができます。

• エントリリストの処理

  　ldap_next_entry()
  　ldap_count_entries()

• DNの読込み/解析

  　ldap_get_dn()

• 属性名の読込み

  　ldap_first_attribute()
  　ldap_next_attribute()

• 属性値の読込み

  　ldap_get_values()
  　ldap_get_values_len()
  　ldap_count_values()
  　ldap_count_values_len()

【指定形式】

#include "idldap.h"
LDAPMessage  *ldap_first_entry(
        LDAP  *ld,
        LDAPMessage  *res );

【パラメタの説明】

• ld

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

• res

  　メッセージリストのアドレスを指定します。ldap_first_entry()、またはldap_next_entry()で通知されたエントリのアドレスを指定した場合は、指定されたエントリを含む残りのエントリの数をカウントします。

【復帰値】

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

• 正常完了の場合 ： 先頭のエントリのアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • パラメタの指定に誤りがあります。

 

ldap_next_entry

　この関数は、直前のldap_first_entry()、またはldap_next_entry()で通知されたエントリの、次のエントリのアドレスを通知します。

　ldap_next_entry()で通知されたエントリのアドレスは、以下の関数においてパラメタとして使用することができます。

• エントリリストの処理

  　ldap_next_entry()
  　ldap_count_entries()

• DNの読込み/解析

  　ldap_get_dn()

• 属性名の読込み

  　ldap_first_attribute()
  　ldap_next_attribute()

• 属性値の読込み

  　ldap_get_values()
  　ldap_get_values_len()
  　ldap_count_values()
  　ldap_count_values_len()

【指定形式】

#include "idldap.h"
LDAPMessage  *ldap_next_entry(
        LDAP  *ld,
        LDAPMessage  *entry );

【パラメタの説明】

• ld

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

• entry

  　直前のldap_first_entry()、またはldap_next_entry()で通知された、エントリのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： 次のエントリのアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • パラメタの指定に誤りがあります。

  　なお、次のエントリがない場合にも、復帰値としてNULLを返します。

 

ldap_count_entries

　この関数は、指定されたメッセージに含まれるエントリの数をカウントします。

【指定形式】

#include "idldap.h"
int  ldap_count_entries(
        LDAP  *ld,
        LDAPMessage  *res );

【パラメタの説明】

• ld

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

• res

  　ldap_first_entry()、またはldap_next_entry()で通知された、エントリのアドレスを指定します。
  　ldap_next_entry()で通知されたエントリのアドレスが指定された場合、それ以降のエントリの個数をカウントします。

【復帰値】

　この関数は、復帰値としてエントリ数を返します。エントリがない場合には、復帰値として0を返します。resパラメタにNULLが指定された場合にも0を返します。

 

ldap_first_attribute

　この関数は、指定されたエントリの最初の属性名を通知します。

【指定形式】

#include "idldap.h"
char  *ldap_first_attribute(
        LDAP  *ld,
        LDAPMessage  *entry,
        BerElement  **ptr );

【パラメタの説明】

• ld

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

• entry

  　ldap_first_entry()、またはldap_next_entry()で通知された、エントリのアドレスを指定します。

• ptr

  　獲得したBerElement構造体のアドレスを格納するための、ポインタ変数のアドレスを指定します。このパラメタが示すポインタ変数は、NULLで初期化しておく必要があります。

【復帰値】

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

• 正常完了の場合 ： 最初の属性名のアドレス
• 異常完了の場合 ： NULL

  　正常完了の場合、獲得したBerElement構造体のアドレスが、ptrパラメタで指定されたポインタ変数に設定されます。
  　異常完了の場合、以下の原因が考えられます。

  • 使用可能なメモリが不足しました。

• 動的メモリの解放

  　ldap_first_attribute()で通知されたBerElement構造体は、不要になった時点でldap_ber_free()を使用して解放しなければなりません。また、ldap_first_attribute()が復帰値として返した属性名の領域は、不要になった時点でldap_memfree()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

   

ldap_next_attribute

　この関数は、直前のldap_first_attribute()、またはldap_next_attribute()で通知された属性名の、次の属性名を通知します。

【指定形式】

#include "idldap.h"
char  *ldap_next_attribute(
        LDAP  *ld,
        LDAPMessage  *entry,
        BerElement  *ber );

【パラメタの説明】

• ld

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

• entry

  　直前のldap_first_attribute()、またはldap_next_attribute()と同じ、エントリのアドレスを指定します。

• ber

  　直前のldap_first_attribute()、またはldap_next_attribute()で使用した、BerElement構造体のアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： 次の属性名のアドレス
• 異常完了の場合 ： NULL

  　正常完了の場合、berパラメタが示すBerElement構造体の内容が更新されます。
  　異常完了の場合、以下の原因が考えられます。

  • 使用可能なメモリが不足しました。

  　なお、次の属性名がない場合にも、復帰値としてNULLを返します。

• 動的メモリの解放

  　ldap_next_attribute()が復帰値として返した属性名の領域は、不要になった時点でldap_memfree()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

   

ldap_get_values

　この関数は、指定されたエントリの属性値を、文字列データとして読み込みます。

　通知されたポインタ配列のメンバが示す属性値は、文字列データです。通知されたポインタ配列のアドレスは、ldap_count_values()のパラメタとして使用します。

【指定形式】

#include "idldap.h"
char  **ldap_get_values(
        LDAP  *ld,
        LDAPMessage  *entry,
        char  *attr );

【パラメタの説明】

• ld

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

• entry

  　ldap_first_entry()、またはldap_next_entry()によって通知された、エントリのアドレスを指定します。

• attr

  　属性名のアドレスを指定します。ldap_first_attribute()、またはldap_next_attribute()によって通知された属性名を指定することができます。

【復帰値】

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

• 正常完了の場合 ： 属性値のポインタ配列のアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • 使用可能なメモリが不足しました。

  　なお、指定された属性がなかった場合にも、復帰値としてNULLを返します。

• 動的メモリの解放

  　ldap_get_values()の復帰値として通知されたポインタ配列は、不要になった時点で、ldap_value_free()を使用して解放しなければなりません。
  　詳細は、“動的メモリの解放”を参照してください。

 

ldap_get_values_len

　この関数は、指定されたエントリの属性値を、バイナリデータとして読み込みます。

【指定形式】

#include "idldap.h"
struct berval  **ldap_get_values_len(
        LDAP  *ld,
        LDAPMessage  *entry,
        char  *attr );

【パラメタの説明】

• ld

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

• entry

  　ldap_first_entry()、またはldap_next_entry()によって通知された、エントリのアドレスを指定します。

• attr

  　属性名のアドレスを指定します。
  　ldap_first_attribute()、またはldap_next_attribute()によって通知された属性名を指定することができます。

【復帰値】

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

• 正常完了の場合 ： 属性値のポインタ配列のアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • 使用可能なメモリが不足しました。

  　なお、指定された属性がない場合にも、復帰値としてNULLを返します。

• 動的メモリの解放

  　ldap_get_values_len()の復帰値として通知されたポインタ配列は、不要になった時点で、ldap_value_free_len()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

 

ldap_count_values

　この関数は、ldap_get_values()で通知された属性値の個数をカウントします。

【指定形式】

#include "idldap.h"
int  ldap_count_values(
        char  **vals );

【パラメタの説明】

• vals

  　ldap_get_values()によって通知された、ポインタ配列のアドレスを指定します。

【復帰値】

　この関数は、復帰値として属性値の数を返します。なお、valsパラメタにNULLが指定された場合は0を返します。

 

ldap_count_values_len

　この関数は、ldap_get_values_len()で通知された属性値の個数をカウントします。

【指定形式】

#include "idldap.h"
int  ldap_count_values_len(
        struct berval  **vals );

【パラメタの説明】

• vals

  　ldap_get_values_len()によって通知された、ポインタ配列のアドレスを指定します。

【復帰値】

　この関数は、復帰値として属性値の数を返します。なお、valsパラメタにNULLが指定された場合は0を返します。

ldap_get_dn

　この関数は、指定されたエントリのDNを読み込みます。

【指定形式】

#include "idldap.h"
char  *ldap_get_dn(
        LDAP  *ld,
        LDAPMessage  *entry );

【パラメタの説明】

• ld

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

• entry

  　ldap_first_entry()、またはldap_next_entry()よって通知された、エントリのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： DNのアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • パラメタの指定に誤りがあります。
  • 使用可能なメモリが不足しました。

• 動的メモリの解放

  　ldap_get_dn()で通知されたDNの領域は、不要になった時点でldap_memfree()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

   

ldap_explode_dn

　この関数は、指定されたDNを、各構成要素に分解します。

【指定形式】

#include "idldap.h"
char  **ldap_explode_dn(
        char  *dn,
        int  notypes );

【パラメタの説明】

• dn

  　DNのアドレスを指定します。

• notypes

  　出力する構成要素の形式として、以下の値を指定します。

  • 0 ： 属性を付加した形式で通知します。
  • 0以外 ： 属性を取り除いた形式で通知します。(o=fujitsu ---> fujitsu)

【復帰値】

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

• 正常完了の場合 ： 各構成要素のポインタ配列のアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • パラメタの指定に誤りがあります。
  • 使用可能なメモリが不足しました。

　ldap_explode_dn()で通知されるデータの例を、下図に示します。

• 動的メモリの解放

  　ldap_explode_dn()で通知された領域は、不要になった時点でldap_value_free()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

   

ldap_explode_rdn

　この関数は、指定されたRDNを、各構成要素に分解します。

【指定形式】

#include "idldap.h"
char  **ldap_explode_rdn(
        char  *rdn,
        int  notypes );

【パラメタの説明】

• rdn

  　RDNのアドレスを指定します。

• notypes

  　出力する構成要素の形式として、以下の値を指定します。

  • 0 ： タイプ情報を付加した形式で通知します。
  • 0以外 ： タイプ情報を取り除いた形式で通知します。(cn=User1 ---> User1)

【復帰値】

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

• 正常完了の場合 ： 各構成要素のポインタ配列のアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • パラメタの指定に誤りがあります。
  • 使用可能なメモリが不足しました。

　ldap_explode_rdn()で通知されるデータについては、ldap_explode_dn()の場合と同じ形式です。

• 動的メモリの解放

  　ldap_explode_rdn()で通知された領域は、不要になった時点でldap_value_free()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。

   

ldap_dn2ufn

　この関数は、指定されたDNを、ユーザフレンドリな形式に変換します。

【指定形式】

#include "idldap.h"
char  *ldap_dn2ufn(
        char  *dn );

【パラメタの説明】

• dn

  　変換するDNのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： ユーザフレンドリなDNのアドレス
• 異常完了の場合 ： NULL

  　異常完了の場合、以下の原因が考えられます。

  • 使用可能なメモリが不足しました。

• 動的メモリの解放

  　ldap_dn2ufn()で通知された領域は、不要になった時点でldap_memfree()を使用して解放しなければなりません。詳細は、“動的メモリの解放”を参照してください。