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

1.20.11.7 ldap_first_message()

名前

　ldap_first_message

形式

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

機能説明

　この関数は、ldap_result()、または同期型の検索処理で通知されたメッセージリスト内の、先頭のメッセージのアドレスを通知します。

　ldap_first_message()で通知されたメッセージのアドレスは、以下の関数においてパラメタとして使用することができます。

• メッセージリスト処理

  　ldap_next_message()
  　ldap_count_messages()

• エラー情報の取得処理（result情報の場合）

  　ldap_parse_result()

• エントリリストの処理

  　ldap_first_entry()
  　ldap_next_entry()
  　ldap_count_entries()

パラメタ

　ld

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

　res

　ldap_result()、または同期型の検索処理で通知された、メッセージリストのアドレスを指定します。

復帰値

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

• 正常終了の場合 ： 先頭のメッセージアドレス
• 異常終了の場合 ： NULL

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