InfoDirectory使用手引書

5.2.17.1 リフェラル情報を含むメッセージの処理

5.2.17.1.1 ldap_first_reference

　この関数は、指定されたメッセージに含まれている、最初のリフェラル情報を含むメッセージのアドレスを通知します。

【指定形式】

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

【パラメタの説明】

• ld

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

• res

  　メッセージのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： 最初のリフェラル情報を含むメッセージのアドレス
• 異常完了の場合 ： NULL

【注意事項】

• 獲得したメッセージのアドレス

  　ldap_first_reference()で通知されたリフェラル情報を含むメッセージのアドレスは、以下の関数においてパラメタとして使用することができます。

  • リフェラル情報を含むメッセージの処理

    　ldap_next_reference()
    　ldap_count_references()

  • リフェラル情報を含むメッセージの解析

    　ldap_parse_reference()

     

5.2.17.1.2 ldap_next_reference

　この関数は、直前のldap_first_reference()またはldap_next_reference()で通知されたメッセージの、次のリフェラル情報を含むメッセージのアドレスを通知します。

【指定形式】

　LDAPMessage　*ldap_next_reference(
　　　　　　　　　LDAP　　 　　*ld,
　　　　　　　　　LDAPMessage　*ref
　　　　　);

【パラメタの説明】

• ld

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

• ref

  　直前のldap_first_reference()またはldap_next_reference()で通知された、リフェラル情報を含むメッセージのアドレスを指定します。

【復帰値】

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

• 正常完了の場合 ： 次のリフェラル情報を含むメッセージのアドレス
• 異常完了の場合 ： NULL

　次のメッセージがない場合には、復帰値としてNULLを返します。

【注意事項】

• 獲得したメッセージのアドレス

  　ldap_next_reference()で通知されたリフェラル情報を含むメッセージのアドレスは、以下の関数においてパラメタとして使用することができます。

  • リフェラル情報を含むメッセージの処理

    　ldap_next_reference()
    　ldap_count_references()

  • リフェラル情報を含むメッセージの解析

    　ldap_parse_reference()

     

5.2.17.1.3 ldap_count_references

　この関数は、メッセージリストに含まれるリフェラル情報を含むメッセージの個数をカウントします。

【指定形式】

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

【パラメタの説明】

• ld

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

• res

  　ldap_first_reference()またはldap_next_reference()で通知された、リフェラル情報を含むメッセージのアドレスを指定します。ldap_next_reference()で通知されたメッセージのアドレスが指定された場合、それ以降のリフェラル情報を含むメッセージの個数をカウントします。

【復帰値】

　この関数は、復帰値としてリフェラル情報を含むメッセージの個数を返します。