ldap_next_attribute()--Retrieve Next Attribute in an Entry

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

The ldap_next_attribute() function returns the next attribute in an entry.

The ldap_next_attribute() function takes an entry returned by ldap_first_entry() or ldap_next_entry() and returns a pointer to a buffer containing the next attribute type in the entry. This string must be freed when its use is completed using ldap_memfree().

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

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld

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

entry

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

berptr

(Input/Output) This parameter specifies a pointer to a BerElement that was allocated by ldap_first_attribute() to keep track of the current position. The BerElement structure is opaque to the application. The caller should free berptr using ldap_ber_free() when finished.

Return Value

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

if the request was successful.

NULL

When there are no attributes left to be retrieved.

Error Conditions

If ldap_next_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. It is left to the user to free outstanding BerElements using ldap_ber_free().

Error Messages

The following message may be sent from this function.

Related Information

• ldap_first_attribute() -- Retrieve first attribute in an entry.
• 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_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 ]