ldap_first_entry

This function returns the first entry of a message.

LDAPMessage* ldap_first_entry(
  LDAP* ld,
  LDAPMessage* res
);

Parameters

  • ld
    [in] Session handle.
  • res
    [in] Search result, as obtained by a call to one of the synchronous search routines or ldap_result.

Return Values

If this function succeeds, it returns the entry. If no entry or reference exists in the result set, it returns NULL and clears the session error parameter in the LDAP data structure to 0.

If this function fails, it returns NULL and sets the session error parameters in the LDAP data structure.

Remarks

Use this function in conjunction with ldap_next_entry to step through and retrieve the list of entries from a search result chain.

You do not have to explicitly free the returned entry as it is freed when the message itself is freed.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Winldap.h.
Link Library: Wldap32.lib.

See Also

ldap_next_entry | ldap_result

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.