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

LDAP_CHARSET

Section: C Library Functions (3)
Updated: 28 March 1996
Index

NAME

ldap_set_string_translators,ldap_t61_to_8859,ldap_8859_to_t61,ldap_translate_from_t61,ldap_translate_to_t61,ldap_enable_translation - LDAP character set translation routines

SYNOPSIS

#include <lber.h>#include <ldap.h>void ldap_set_string_translators( ld, encode_proc, decode_proc )LDAP                    *ld;BERTranslateProc        encode_proc;BERTranslateProc        decode_proc;typedef int (*BERTranslateProc)( char **bufp, unsigned long *buflenp,        int free_input );int ldap_t61_to_8859( bufp, buflenp, free_input )char            **bufp;unsigned long   *buflenp;int             free_input;int ldap_8859_to_t61( bufp, buflenp, free_input )char            **bufp;unsigned long   *buflenp;int             free_input;int ldap_translate_from_t61( ld, bufp, lenp, free_input )LDAP            *ld;char            **bufp;unsigned long   *lenp;int             free_input;int ldap_translate_to_t61( ld, bufp, lenp, free_input )LDAP            *ld;char            **bufp;unsigned long   *lenp;int             free_input;void ldap_enable_translation( ld, entry, enable )LDAP            *ld;LDAPMessage     *entry;int             enable;

DESCRIPTION

These routines are used to used to enable translation of character stringsused in the LDAP library to and from the T.61 character set used in theLDAP protocol. These functions are only available if the LDAP and LBERlibraries are compiled with STR_TRANSLATION defined.It is also possible to turn on character translation by default so thatall LDAP library callers will experience translation; see the LDAPMake-common source file for details.

ldap_set_string_translators()sets the translation routines that willbe used by the LDAP library. They are not actually used until theld_lberoptions field of the LDAP structure is set to include theLBER_TRANSLATE_STRINGS option.

ldap_t61_to_8859()andldap_8859_to_t61()are translation routines forconverting between T.61 characters and ISO-8859 characters. The specific8859 character set used is determined at compile time.

ldap_translate_from_t61()is used to translate a string of characters from the T.61 character set to adifferent character set. The actual translation is done using thedecode_proc that was passed to a previous call toldap_set_string_translators().On entry, *bufp should point to the start of the T.61 charactersto be translated and *lenp should contain the number of bytes totranslate. If free_input is non-zero, the input buffer will befreed if translation is a success. If the translation is a success,LDAP_SUCCESS will be returned, *bufp will point to a newlymalloc'd buffer that contains the translated characters, and*lenp will contain the length of the result. If translationfails, an LDAP error code will be returned.

ldap_translate_to_t61()is used to translate a string of characters to the T.61 character set from adifferent character set. The actual translation is done using theencode_proc that was passed to a previous call toldap_set_string_translators().This function is called just likeldap_translate_from_t61().

ldap_enable_translation()is used to turn on or off string translation for the LDAP entry entry(typically obtained by callingldap_first_entry()orldap_next_entry()after a successful LDAP search operation). If enable is zero,translation is disabled; if non-zero, translation is enabled. This routineis useful if you need to ensure that a particular attribute is nottranslated when it is extracted usingldap_get_values()orldap_get_values_len().For example, you would not want to translate a binary attributes such asjpegPhoto.

This document was created byman2html,using the manual pages.

LDAP_CHARSET

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO

Index