Export (0) Print
Expand All
Expand Minimize

ldap_parse_reference function

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

Syntax


ULONG ldap_parse_reference(
  _In_   LDAP *Connection,
  _In_   LDAPMessage *ResultMessage,
  _Out_  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 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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

Unicode and ANSI names

ldap_parse_referenceW (Unicode) and ldap_parse_referenceA (ANSI)

See also

Functions
LDAPMessage
ldap_parse_result
ldap_value_free

 

 

Show:
© 2014 Microsoft