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

1.20.12.4 ldap_first_attribute()

名前

　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構造体のアドレスを格納するための、ポインタ変数のアドレスを指定します。

復帰値

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

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

  この属性名のアドレスを、ldap_get_values()、またはldap_get_values_len()のパラメタattrに指定します。また、獲得したBerElement構造体のアドレスが、ptrパラメタで指定されたポインタ変数に設定されます。

• 異常終了の場合 ： NULL

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

注意事項

• 動的メモリの解放

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