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

LDAP_GET_VALUES

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

NAME

ldap_get_values, ldap_get_values_len, ldap_count_values - LDAP attribute value handling routines

SYNOPSIS

#include <lber.h>#include <ldap.h>typedef struct berval {    unsigned long bv_len;    char *bv_val;};char **ldap_get_values(ld, entry, attr)LDAP *ld;LDAPMessage *entry;char *attrstruct berval **ldap_get_values_len(ld, entry, attr)LDAP *ld;LDAPMessage *entry;char *attrldap_count_values(vals)char **vals;ldap_count_values_len(vals)struct berval **vals;ldap_value_free(vals)char **vals;ldap_value_free_len(vals)struct berval **vals;

DESCRIPTION

These routines are used to retrieve and manipulate attribute valuesfrom an LDAP entry as returned byldap_first_entry(3)orldap_next_entry(3).ldap_get_values()takes the entry and the attribute attrwhose values are desired and returns a NULL-terminated array of theattribute's values. attr may be an attribute type as returnedfromldap_first_attribute(3)orldap_next_attribute(3),or if the attribute type is known it can simply be given.

The number of values in the array can be counted by callingldap_count_values().The array of values returned can be freed by callingldap_value_free().

If the attribute values are binary in nature, and thus not suitableto be returned as an array of char *'s, theldap_get_values_len()routine can be used instead. It takes the same parameters asldap_get_values(),but returns a NULL-terminated array of pointersto berval structures, each containing the length of and a pointerto a value.

The number of values in the array can be counted by callingldap_count_values_len().The array of values returned can be freed by callingldap_value_free_len().

ERRORS

If an error occurs inldap_get_values()orldap_get_values_len(),NULL is returned and theld_errnofield in the ld parameter is set toindicate the error. Seeldap_error(3)for a description of possible error codes.

NOTES

These routines malloc memory that the caller must free.

This document was created byman2html,using the manual pages.