ldap_first_attribute

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function returns the first attribute for a given directory entry.

Syntax

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

Parameters

• ld
  [in] Session handle.

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

• ptr
  [out] Address of a pointer used internally to keep track of the current position in the entry.

Return Value

If this 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 this function fails, it returns NULL.

Remarks

Use this function 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 ber_free (ptr, 0).

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

See Also

Reference

BerElement
ldap_first_entry
ldap_get_values
ldap_memfree
ldap_next_attribute
ldap_next_entry