xref: /illumos-gate/usr/src/man/man3ldap/ldap_first_attribute.3ldap (revision f37b3cbb6f67aaea5eec1c335bdc7bf432867d64)
te
Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LDAP_FIRST_ATTRIBUTE 3LDAP "March 10, 2023"
NAME
ldap_first_attribute, ldap_next_attribute - step through LDAP entry attributes
SYNOPSIS
cc [ flag...] file... -lldap[ library...]
#include <lber.h>
#include <ldap.h>

char *ldap_first_attribute(LDAP *ld, LDAPMessage *entry,
 BerElement **berptr);

char *ldap_next_attribute(LDAP *ld, LDAPMessage *entry,
 BerElement *ber);
DESCRIPTION
The ldap_first_attribute() function gets the value of the first attribute in an entry.

The ldap_first_attribute() function returns the name of the first attribute in the entry. To get the value of the first attribute, pass the attribute name to the ldap_get_values() function or to the ldap_get_values_len() function.

The ldap_next_attribute() function gets the value of the next attribute in an entry.

After stepping through the attributes, the application should call ber_free() to free the BerElement structure allocated by the ldap_first_attribute() function if the structure is other than NULL.

ERRORS
If an error occurs, NULL is returned and the ld_errno field in the ld parameter is set to indicate the error. See ldap_error(3LDAP) for a description of possible error codes.
ATTRIBUTES
See attributes(7) for a description of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO
ldap (3LDAP), ldap_error (3LDAP), ldap_first_entry (3LDAP), ldap_get_values (3LDAP), attributes (7)
NOTES
The ldap_first_attribute() function allocates memory that might need to be freed by the caller by means of ber_free(3LDAP).