InfoDirectory SDK 使用手引書

2.2.17.2 エントリリストの処理

2.2.17.2.1 ldap_first_entry

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

【指定形式】

　LDAPMessage　*ldap_first_entry(
　　　　　　　　　LDAP　　　　 *ld,
　　　　　　　　　LDAPMessage　*res
　　　　　);

【パラメタの説明】

• ld

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

• res

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

【復帰値】

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

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

【注意事項】

• 獲得したエントリのアドレス

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

  • LDAPコントロールの読込み

    　ldap_get_entry_controls()

     

2.2.17.2.2 ldap_next_entry

　この関数は、直前のldap_first_entry()またはldap_next_ entry()で通知されたエントリの、次のエントリのアドレスを通知します。

【指定形式】

　LDAPMessage　*ldap_next_entry(
　　　　　　　　　LDAP　　　　 *ld,
　　　　　　　　　LDAPMessage　*entry
　　　　　);

【パラメタの説明】

• ld

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

• entry

  　直前のldap_first_entry()またはldap_next_ entry()で通知された、エントリのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： 次のエントリのアドレス
• 異常完了の場合 ： NULL

　次のエントリがない場合には、復帰値としてNULLを返します。

【注意事項】

• 獲得したエントリのアドレス

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

  • LDAPコントロールの読込み

    　ldap_get_entry_controls()

     

2.2.17.2.3 ldap_count_entries

　この関数は、指定されたメッセージに含まれるエントリの数をカウントします。

【指定形式】

　int　ldap_count_entries(
　　　　　　　　　LDAP　　　　 *ld,
　　　　　　　　　LDAPMessage　*res
　　　　　);

【パラメタの説明】

• ld

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

• res

  　ldap_first_entrie()またはldap_next_entry()で通知された、エントリのアドレスを指定します。
  　ldap_next_entry()で通知されたエントリのアドレスが指定された場合、それ以降のエントリの個数をカウントします。

【復帰値】

　この関数は、復帰値としてエントリ数を返します。残りのエントリがない場合には、復帰値として0を返します。