ldap_first_entry

The ldap_first_entry function returns the first entry of a message.

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

Parameters

ld

[in] The session handle.

res

[in] The search result, as obtained by a call to one of the synchronous search routines or ldap_result.

Return Values

If the function succeeds, it returns the entry. If no entry or reference exists in the result set, it returns NULL.

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

Remarks

Use ldap_first_entry 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

  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.

See Also

Functions, ldap_next_entry, ldap_result