Copyright Digital Equipment Corp. All rights reserved.

Parsing_References

   The ldap_parse_reference() function is used to extract referrals
   and controls from a SearchResultReference message.

           int ldap_parse_reference(
                   LDAP                            *ld,
                   LDAPMessage                     *ref,
                   char                            ***referralsp,
                   LDAPControl                     ***serverctrlsp,
                   int                             freeit
           );

   Parameters are as follows:

   ld             The session handle.
   ref            The reference to parse, as returned by ldap_
                  result(), ldap_first_reference(),  or ldap_next_
                  reference().
   referralsp     This result parameter will be filled in with an
                  allocated array of character strings. The elements
                  of the array are the referrals (typically LDAP
                  URLs) contained in ref. The array should be freed
                  when no longer in used by calling ldap_value_
                  free(). If referralsp is NULL, the referral URLs
                  are not returned.
   serverctrlsp   This result parameter will be filled in with an
                  allocated array of controls copied out of ref.
                  The control array should be freed by calling
                  ldap_controls_free(). If serverctrlsp is NULL,
                  no controls are returned.
   freeit         A boolean that determines whether or not the ref
                  parameter is disposed of. Pass any non-zero value
                  to have these functions free ref after extracting
                  the requested information. This option is provided
                  as a convenience; you can also use ldap_msgfree()
                  to free the result later.

   The ldap_parse_reference() function returns an LDAP error code
   that indicates whether the reference could be successfully parsed
   (LDAP_SUCCESS if all goes well).