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

1.20.12.1 ldap_first_entry()

名前

　ldap_first_entry

形式

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

機能説明

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

　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()

パラメタ

　ld

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

　res

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

復帰値

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

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

  　異常終了の場合のエラー原因は、ldap_get_option()のLDAP_OPT_RESULT_CODEオプションで参照してください。