ldap_set_iconv_local_codepage() -- Set the Active LDAP Code Page

Syntax

 #include <ldap.h>
 
 int
 ldap_set_iconv_local_codepage ( char *codepage )

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_set_iconv_local_codepage() API is used to set a global variable, ldap_global_codepage, to a value passed by codepage or to a value associated with a locale if codepage is NULL.

NOTE that the word local in the API refers to the value of the global variable ldap_global_codepage if it is set or a codepage value associated with the current locale.

Authorities and Locks

No IBM^® i authority is required.

Parameters

codepage: (input) specifies local code page value.

Return Value

LDAP_SUCCESS: if the request was successful.
Other LDAP error code: if the request was not successful.

Error Conditions

The ldap_set_iconv_local_codepage() API will return an LDAP error code if not successful. See LDAP Client API Error Conditions for possible values for LDAP error codes.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_set_iconv_local_codepage API.

Related Information

ldap_xlate_local_to_utf8() -- Convert string from the local to UTF-8 code page.
ldap_xlate_utf8_to_local() -- Convert string from UTF-8 to local code page.
ldap_xlate_local_to_unicode() -- Convert string from the local to UCS-2 code page.
ldap_xlate_unicode_to_local() -- Convert string From UCS-2 to local code page.
ldap_get_iconv_local_codepage() -- Get the active LDAP code page.
ldap_set_iconv_local_charset() -- Set the active LDAP character set.
ldap_set_locale() -- Change the locale used by LDAP.
ldap_get_locale() -- Get the locale used by LDAP.

API introduced: V4R5

[ Back to top | LDAP APIs | APIs by category ]