Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ldap_get_lang_values(3ldap) [sunos man page]

ldap_get_lang_values(3LDAP)				      LDAP Library Functions				       ldap_get_lang_values(3LDAP)

NAME
ldap_get_lang_values, ldap_get_lang_values_len - return an attribute's values that matches a specified language subtype SYNOPSIS
cc -flag ... file ...-lldap [-library ...] #include <ldap.h> char **ldap_get_lang_values(LDAP *ld, LDAPMessage *entry, const char *target, char **type); struct berval **ldap_get_lang_values_len(LDAP *ld, LDAPMessage *entry, const char *target, char **type); DESCRIPTION
The ldap_get_lang_values() function returns an array of an attribute's string values that matches a specified language subtype. To retrieve the binary data from an attribute, call the ldap_get_lang_values_len() function instead. ldap_get_lang_values() should be called to retrieve a null-terminated array of an attribute's string values that match a specified language subtype. The entry parameter is the entry retrieved from the directory. The target parameter should contain the attribute type the values that are required, including the optional language subtype. The type parameter points to a buffer that returns the attribute type retrieved by this function. Unlike the ldap_get_values() function, if a language subtype is specified, this function first attempts to find and return values that match that subtype, for example, cn;lang-en. ldap_get_lang_values_len() returns a null-terminated array of pointers to berval structures, each containing the length and pointer to a binary value of an attribute for a given entry. The entry parameter is the result returned by ldap_result() or ldap_search_s() functions. The target parameter is the attribute returned by the call to ldap_first_attribute() or ldap_next_attribute(), or the attribute as a lit- eral string, such as jpegPhoto or audio. These functions are deprecated. Use ldap_get_values() or ldap_get_values_len() instead. RETURN VALUES
If successful, ldap_get_lang_values() returns a null-terminated array of the attribute's values. If the call is unsuccessful, or if no such attribute exists in the entry, it returns a NULL and sets the appropriate error code in the LDAP structure. The ldap_get_lang_values_len() function returns a null-terminated array of pointers to berval structures, which in turn, if successful, contain pointers to the attribute's binary values. If the call is unsuccessful, or if no such attribute exists in the entry, it returns a NULL and sets the appropriate error code in the LDAP structure. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWcsl (32-bit) | +-----------------------------+-----------------------------+ | |SUNWcslx (64-bit) | +-----------------------------+-----------------------------+ |Interface Stability |Obsolete | +-----------------------------+-----------------------------+ SEE ALSO
ldap_first_attribute(3LDAP), ldap_next_attribute(3LDAP), ldap_get_values(3LDAP), ldap_result(3LDAP), ldap_search_s(3LDAP), attributes(5) SunOS 5.10 25 Oct 2001 ldap_get_lang_values(3LDAP)

Check Out this Related Man Page

ldap_get_values(3LDAP)					      LDAP Library Functions					    ldap_get_values(3LDAP)

NAME
ldap_get_values, ldap_get_values_len, ldap_count_values, ldap_count_values_len, ldap_value_free, ldap_value_free_len - LDAP attribute value handling functions SYNOPSIS
cc[ flag... ] file... -lldap[ library... ] #include <lber.h> #include <ldap.h> char **ldap_get_values(LDAP *ld, LDAPMessage *entry, char *attr); struct berval **ldap_get_values_len(LDAP *ld, LDAPMessage *entry, char *attr); ldap_count_values(char **vals); ldap_count_values_len(struct berval **vals); ldap_value_free(char **vals); ldap_value_free_len(struct berval **vals); DESCRIPTION
These functions are used to retrieve and manipulate attribute values from an LDAP entry as returned by ldap_first_entry(3LDAP) or ldap_next_entry(3LDAP). ldap_get_values() takes the entry and the attribute attr whose values are desired and returns a null-terminated array of the attribute's values. attr may be an attribute type as returned from ldap_first_attribute(3LDAP) or ldap_next_attribute(3LDAP), or if the attribute type is known it can simply be given. The number of values in the array can be counted by calling ldap_count_values(). The array of values returned can be freed by calling ldap_value_free(). If the attribute values are binary in nature, and thus not suitable to be returned as an array of char *'s, the ldap_get_values_len() func- tion can be used instead. It takes the same parameters as ldap_get_values(), but returns a null-terminated array of pointers to berval structures, each containing the length of and a pointer to a value. The number of values in the array can be counted by calling ldap_count_values_len(). The array of values returned can be freed by calling ldap_value_free_len(). ERRORS
If an error occurs in ldap_get_values() or ldap_get_values_len(), NULL returned and the ld_errno field in the ld parameter is set to indi- cate the error. See ldap_error(3LDAP) for a description of possible error codes. ATTRIBUTES
See attributes(5) for a description of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |Availability |SUNWcsl (32-bit) | | |SUNWcslx (64-bit) | |Interface Stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
ldap(3LDAP), ldap_first_entry(3LDAP), ldap_first_attribute(3LDAP), ldap_error(3LDAP), attributes(5) NOTES
These functions allocates memory that the caller must free. SunOS 5.11 28 Jan 2002 ldap_get_values(3LDAP)
Man Page