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

1.20.11.4 ldap_parse_result()

名前

　ldap_parse_result

形式

　#include "idldap.h"
　int  ldap_parse_result(
　        LDAP  *ld,
　        LDAPMessage  *res,
　        int  *errcodep,
　        char  **matcheddnp,
　        char  **errmsgp,
　        char  ***referralsp,
　        LDAPControl  ***serverctrlsp,
　        int  freeit );

機能説明

　この関数は、受信したresult情報内の各種情報を読み込みます。この関数は、LDAP_RES_SEARCH_ENTRY以外のresult情報に対して使用します。

パラメタ

　ld

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

　res

　result情報のアドレスを指定します。

　errcodep

　result情報に含まれるLDAPエラーコードを格納する、変数のアドレスを指定します。LDAPエラーコードを読み込まない場合は、このパラメタにNULLを指定します。

　matcheddnp

　一致した範囲を示すDNのアドレスを格納する、ポインタ変数のアドレスを指定します。一致した範囲を示すDNを読み込まない場合は、このパラメタにNULLを指定します。

　errmsgp

　詳細エラーメッセージのアドレスを格納する、変数のアドレスを指定します。詳細エラーメッセージを読み込まない場合は、このパラメタにNULLを指定します。

　referralsp

　Smart Repositoryではリフェラルをサポートしないため、このパラメタにはNULLを指定します。

　serverctrlsp

　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

　freeit

　呼出し元に復帰する際に、resパラメタで指定したresult情報を解放するかどうかを指定します。

• result情報を解放する場合 ： 0以外を指定
• result情報を解放しない場合 ： 0を指定

復帰値

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

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

　正常終了の場合は、パラメタで指定した変数に、以下の情報が設定されます。

• errcodepパラメタで指定された変数

  　LDAPエラーコードが設定されます。

• matcheddnpパラメタで指定された変数

  　適合したDNの範囲を示す文字列のアドレスが設定されます。この領域は不要になった時点でldap_memfree()を使用し解放しなければなりません。

• errmsgpパラメタで指定された変数

  　指定されたresult情報内の、詳細エラーメッセージのアドレスが設定されます。この領域は不要になった時点でldap_memfree()を使用し解放しなければなりません。

注意事項

• result情報の解放

  　ldap_parse_result()を呼び出す際に、freeitパラメタに0以外の値を指定した場合、ライブラリ内部でldap_msgfree()使用してresult情報を解放します。このため、これ以降は、result情報にアクセスできなくなります。ldap_parse_result()を呼び出す際に、freeitパラメタに0を指定した場合には、不要になった時点で、呼出し元がldap_msgfree()使用してresult情報を解放しなければなりません。