ldap_parse_reference

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

See Also

Reference

LDAP_RETCODE
LDAPMessage
ldap_parse_result
ldap_value_free