summaryrefslogtreecommitdiff
path: root/fpcdocs/clocale.xml
blob: a473fe9b0d3dafc77c7d245ba6879df7b839f43e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="rtl">

<!--
  ====================================================================
    clocale
  ====================================================================
-->

<module name="clocale">
<short>Initialize internationalization settings from the C library</short>
<descr>
<p>
The <var>clocale</var> offers no API by itself: it just initializes the
internationalization settings of the <link id="#rtl.sysutils">sysutils</link>
unit with the values provided by the C library found on most Unix or Linux
systems that are POSIX compliant.
</p>
<p>
The <file>clocale</file> should simply be included in the uses clause of the
program, preferably as one of the first units, and the initialization
section of the unit will do all the work.
</p>
<p>
Note that including this unit, links your program to the C library of the
system.
</p>
<p>
It makes no sense to use this unit on a non-posix system: Windows, OS/2 or
DOS - therefore it should always be between an ifdef statement:
</p>
<code>
program myprogram;

uses 
  {$ifdef unix}clocale{$endif},
   classes, sysutils;
</code>
</descr>

</module> <!-- clocale -->

</package>
</fpdoc-descriptions>