Share via

ldap_parse_reference (Compact 2013)

  • Article

3/26/2014

This function returns a list of subordinate referrals in a search response message.

Syntax

ULONG ldap_parse_reference(
  LDAP* Connection,
  LDAPMessage* ResultMessage,
  UNICODE PTCHAR** Referrals
);

Parameters

  • Connection
    [in] Session handle.
  • ResultMessage
    [in] Pointer to an LDAPMessage structure containing the search response.
  • Referrals
    [out] Pointer to the list of subordinate referrals.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

This function returns a list of referrals in the form of URLs. Call this function if a call to ldap_parse_result indicates that there are referrals.

When it is no longer needed, free the Referrals pointer by calling the ldap_value_free function.

Requirements

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Search Functions
LDAP_RETCODE
LDAPMessage
ldap_parse_result
ldap_value_free