191 lines
5.4 KiB
HTML
191 lines
5.4 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>ldap_set_locale() -- Change the Locale Used by LDAP</title><!-- Begin Header Records -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- File Edited April 2001 -->
|
||
|
|
<!-- This file has undergone html cleanup on 2/19/02 by JET -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2>ldap_set_locale() -- Change the Locale Used by LDAP</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
int ldap_set_locale(
|
||
|
|
char *<em>locale</em> )
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_set_locale()</strong> API is used to change the locale used
|
||
|
|
by LDAP for conversions between the local code page and UTF-8 or Unicode.
|
||
|
|
Unless explicitly set with the <strong>ldap_set_locale()</strong> API, LDAP
|
||
|
|
will use the application's default locale. To force the LDAP library to use
|
||
|
|
another locale, specify the appropriate locale string.</p>
|
||
|
|
|
||
|
|
<p>Note that the specified locale is applicable to all conversions by the LDAP
|
||
|
|
library within the applications address space. The LDAP locale should be set or
|
||
|
|
changed only when there is no other LDAP activity occuring within the
|
||
|
|
application on other threads.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>*R authority is needed to the selected locale file and *X to the associated
|
||
|
|
directories.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>locale</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The locale to be used by LDAP when using conversion apis to convert
|
||
|
|
local text to/from UTF-8 or Unicode. If the locale is not explicitly set, the
|
||
|
|
LDAP library will use the application's default locale. To force the LDAP
|
||
|
|
library to use another locale, specify the appropriate locale string.
|
||
|
|
|
||
|
|
<p>You can set the value of <em>locale</em> to C, "", LC_C or the IFS pathname
|
||
|
|
of a *LOCALE object. A <em>locale</em> value of C indicates the default C
|
||
|
|
environment. A locale value of "" tells <strong>ldap_set_locale()</strong> to
|
||
|
|
use the default locale for the implementation.</p>
|
||
|
|
|
||
|
|
<p>Examples:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
rc = ldap_set_locale(LC_C);
|
||
|
|
|
||
|
|
rc = ldap_set_locale("/qsys.lib/en_us.locale");
|
||
|
|
</pre>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the request was successful.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>another LDAP error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the request was not successful.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_set_locale()</strong> API will return LDAP error code if
|
||
|
|
not successful. See <a href="ldap_error_condt.htm">LDAP Client API Error
|
||
|
|
Conditions</a> for possible values for LDAP error codes.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<p>The following message may be sent from this function.</p>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="3">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3CF2 E</td>
|
||
|
|
<td width="85%" valign="top">Error(s) occurred during running of
|
||
|
|
ldap_set_locale API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_xlate_local_to_utf8.htm">ldap_xlate_local_to_utf8()</a> --
|
||
|
|
Convert string from the local to UTF-8 code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_xlate_utf8_to_local.htm">ldap_xlate_utf8_to_local()</a> --
|
||
|
|
Convert string From UTF-8 to local code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_xlate_local_to_unicode.htm">ldap_xlate_local_to_unicode()</a>
|
||
|
|
-- Convert string from the local to UCS-2 code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_xlate_unicode_to_local.htm">ldap_xlate_unicode_to_local()</a>
|
||
|
|
-- Convert string from UCS-2 to local code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_get_iconv_local_codepage.htm">
|
||
|
|
ldap_get_iconv_local_codepage()</a> -- Get the active LDAP code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_set_iconv_local_codepage.htm">
|
||
|
|
ldap_set_iconv_local_codepage()</a> -- Set the active LDAP code page.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_set_iconv_local_charset.htm">
|
||
|
|
ldap_set_iconv_local_charset()</a> -- Set the active LDAP character set.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_get_locale.htm">ldap_get_locale()</a> -- Get the locale used
|
||
|
|
by LDAP.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R5
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"dirserv1.htm">LDAP APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|