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

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Winldap.h.
  Library: Use Wldap32.lib.
  Unicode: Declared as Unicode and ANSI prototypes.

See Also

Functions, LDAPMessage, ldap_parse_result, ldap_value_free