MAN page from RedHat Other ldap-devel-3.3-3.i386.rpm

LDAP_FIRST_ATTRIBUTE

Section: C Library Functions (3)
Updated: 25 November 1994
Index

NAME

ldap_first_attribute, ldap_next_attribute - step through LDAP entry attributes

SYNOPSIS

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

DESCRIPTION

Theldap_first_attribute()andldap_next_attribute()routines are usedto step through the attributes in an LDAP entry.ldap_first_attribute()takes an entry as returned byldap_first_entry(3)orldap_next_entry(3)and returns a pointer to a per-connection buffercontaining the first attribute type in the entry. The return valueshould be treated as if it is a pointer to a static area (i.e.,strdup(3)it if you want to save it).

It also returns, in berptr, a pointer to a BerElement it hasallocated to keep track of its current position. This pointer shouldbe passed to subsequent calls toldap_next_attribute()and is used usedto effectively step through the entry's attributes. This pointeris freed byldap_next_attribute()when there are no more attributes (thatis, whenldap_next_attribute()returns NULL). Otherwise, the caller isresponsible for freeing the BerElement pointed to by berptr whenit is no longer needed by callingber_free(3).When callingber_free(3)in this instance, be sure the second argument is 0.

The attribute names returned are suitable for inclusion in a calltoldap_get_values(3)to retrieve the attribute's values.

ERRORS

If an error occurs, NULL is returned and the ld_errno field in theld parameter is set to indicate the error. Seeldap_error(3)for a description of possible error codes.

NOTES

Theldap_first_attribute()routine mallocs memory that may need tobe freed by the caller viaber_free(3).

This document was created byman2html,using the manual pages.