ldap_first_attribute

For a given directory entry, the ldap_first_attribute function returns the first attribute.

PCHAR ldap_first_attribute(
  LDAP* ld,
  LDAPMessage* entry,
  BerElement** ptr
);

Parameters

ld

[in] The session handle.

entry

[in] The entry whose attributes are to be stepped through, as returned by ldap_first_entry or ldap_next_entry.

ptr

[out] The address of a pointer used internally to keep track of the current position in the entry.

Return Values

If the function succeeds, it returns a pointer to an allocated buffer containing the current attribute name. When there are no more attributes to step through, it returns NULL.

If the function fails, it returns NULL.

Remarks

Use ldap_first_attribute in conjunction with ldap_next_attribute to step through the list of attribute types returned with an entry. You can then pass these attribute names in a call to ldap_get_values to retrieve their associated values.

A call to ldap_first_attribute allocates, and returns through the ptr parameter, a pointer to a BerElement structure. Pass this pointer to ldap_next_attribute to keep track of the current position in the list of attributes. When you have finished stepping through a list of attributes and ptr is non-NULL, free the pointer by calling ldap_ber_free( ptr, 0 ). Note that it is very important to pass the second parameter as 0 (zero) in this call.

Both ldap_first_attribute and ldap_next_attribute return a pointer to an allocated buffer containing the current attribute name. This should be freed when no longer in use by calling ldap_memfree.

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.
  Unicode: Declared as Unicode and ANSI prototypes.

See Also

BerElement, Functions, ldap_first_entry, ldap_get_values, ldap_memfree, ldap_next_attribute, ldap_next_entry