ldap_first_attribute()--Retrieve First Attribute in an Entry

 #include <ldap.h>
 
 char *ldap_first_attribute(
                 LDAP         *ld,
                 LDAPMessage  *entry,
                 BerElement  **berptr)

The ldap_first_attribute() function returns the first attribute in an entry. The ldap_first_attribute() and ldap_next_attribute() functions are used to step through the attributes in an LDAP entry.

ldap_first_attribute() takes an entry returned by ldap_first_entry() or ldap_next_entry() and returns a pointer to a buffer containing a null terminated string that is the first attribute type in the entry. This buffer must be freed when its use is completed using ldap_memfree(). *berptr also must be freed when its use is completed using ldap_ber_free().

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld

(Input) The LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), ldap_app_ssl_init_np(), or ldap_open().

entry

(Input) The attribute information as returned by ldap_first_entry() or ldap_next_entry().

berptr

(Output) A pointer to a BerElement that will be allocated to keep track of the current position. It is an input and output parameter for subsequent calls to ldap_next_attribute(). The BerElement structure is opaque to the application. Free *berptr when its use is completed using ber_free.

Return Value

Pointer to a buffer containing the first attribute type in the entry

if the request was successful.

NULL

if the request was not successful.

Error Conditions

If ldap_first_attribute() is not successful, NULL is returned, and ld_errno will be set to indicate the error. See LDAP Client API Error Conditions for possible LDAP error code values. Use ldap_get_errno() function to retrieve the error information.

Error Messages

The following message may be sent from this function.

Related Information

• ldap_first_entry() -- Retrieve first LDAP entry.
• ldap_next_entry() -- Retrieve next LDAP entry.
• ldap_count_attributes() -- Retrieve count of attributes for an LDAP entry.
• ldap_next_attribute() -- Return next attribute name in an entry.
• ldap_get_values() -- Retrieve a set of attribute values from an entry.
• ldap_get_values_len() -- Retrieve a set of binary attribute values.

[ Back to top | LDAP APIs | APIs by category ]