ldap_parse_reference

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

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

Parameters

Connection

[in] The session handle.

ResultMessage

[in] A pointer to an LDAPMessage structure containing the search response.

Referrals

[out] A pointer to the list of subordinate referrals. Free with ldap_value_free.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

The ldap_parse_reference 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 ldap_value_free.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, LDAPMessage, ldap_parse_result, ldap_value_free