ldap_parse_referenceW function (winldap.h)

Article
02/22/2024

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

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_parse_referenceW(
  [in]  LDAP        *Connection,
  [in]  LDAPMessage *ResultMessage,
  [out] PWCHAR      **Referrals
);

Parameters

[in] Connection

The session handle.

[in] ResultMessage

A pointer to an LDAPMessage structure containing the search response.

[out] Referrals

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

Return value

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.

Note

The winldap.h header defines ldap_parse_reference as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	winldap.h
Library	Wldap32.lib
DLL	Wldap32.dll