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

1.20.11.1 ldap_result()

名前

　ldap_result

形式

　#include "idldap.h"
　int  ldap_result(
　        LDAP  *ld,
　        int  msgid,
　        int  all,
　        struct timeval  *timeout,
　        LDAPMessage  **resp );

機能説明

　この関数は、非同期関数の処理結果や検索結果のエントリを受け取ります。

　取得したresult情報がどの非同期要求に対するものか判定する場合、ldap_msgid()でresult情報のメッセージIDを参照します。result情報には、対応する非同期要求のメッセージIDが付加されています。

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

パラメタ

　ld

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

　msgid

　非同期関数で通知されたメッセージIDを指定します。また、受け取る処理結果を特定しない場合には、LDAP_RES_ANYを指定します。LDAP_RES_ANYを指定した場合は、最初に受信したメッセージが通知されます。

　all

　処理結果のメッセージが複数ある場合の処理として、以下のどれか1つを指定します。

• LDAP_MSG_ALL ： 要求したmsgidパラメタに対応する処理結果メッセージをすべて受信した後で、呼出し元に復帰します。
• LDAP_MSG_ONE ： 要求したmsgidパラメタに対応する処理結果メッセージを1個受信するごとに、呼出し元へ復帰します。
• LDAP_MSG_RECEIVED ： 現在受信済の処理結果メッセージの中から、msgidパラメタで指定された条件に合うものを読み込んで呼出し元へ復帰します。
  　

　timeout

　受信待ち時間を設定した領域のアドレスを指定します。timeval構造体のメンバには、以下の値を設定します。

• tv_sec ： タイマー値（秒単位）
• tv_usec ： タイマー値（マイクロ秒単位）

　timeoutパラメタにNULLポインタを指定すると、結果を受け取るまで呼出し元に復帰しません。また、timeval構造体のtv_secパラメタ、およびtv_usecパラメタに0を設定した場合は、指定されたメッセージが到着しているかどうかの判定を行い、メッセージが到着していなかった場合には、すぐにタイムアウトで復帰します。

　resp

　LDAPMessage構造体のポインタ変数のアドレスを指定します。

復帰値

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

• 正常終了 ： メッセージのタイプ（メッセージリストの先頭）
• タイムアウト ： 0
• 異常終了 ： -1

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

  　正常終了の場合に通知されるメッセージのタイプを、以下に示します。

  メッセージタイプ	値	説明
  LDAP_RES_BIND	0x61	リポジトリサーバとのユーザ認証(BIND)に対するresult情報です。
  LDAP_RES_SEARCH_ENTRY	0x64	エントリの検索(SEARCH)でヒットしたエントリを表しています。
  LDAP_RES_SEARCH_RESULT	0x65	エントリの検索(SEARCH)に対するresult情報です。
  LDAP_RES_MODIFY	0x67	エントリの変更(MODIFY)に対するresult情報です。
  LDAP_RES_ADD	0x69	エントリの追加(ADD)に対するresult情報です。
  LDAP_RES_DELETE	0x6B	エントリの削除(DELETE)に対するresult情報です。
  LDAP_RES_MODDN	0x6D	エントリ名の変更(MODDN)に対するresult情報です。
  LDAP_RES_COMPARE	0x6F	属性値の比較(COMPARE)に対するresult情報です。

　受信したメッセージが存在する場合は、respパラメタが示すポインタ変数に、メッセージリストの先頭アドレスが設定されます。
　LDAPMessageの通知形式を以下に示します。

　ldap_result()で通知されたメッセージリストは、メッセージリスト処理においてパラメタとして指定します。

注意事項

• 動的メモリの解放

  　ldap_result()で通知されたメッセージリストは、不要になった時点でldap_msgfree()を使用して解放しなければなりません。詳細は、“動的メモリの解放インタフェース”を参照してください。