reference/gettext/functions/bind-textdomain-codeset.xml
59e6c121147bd1b203f02a15c8a067c964ae4e99
59e6c121147bd1b203f02a15c8a067c964ae4e99
...
...
@@ -1,21 +1,21 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='function.bind-textdomain-codeset' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="function.bind-textdomain-codeset" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>bind_textdomain_codeset</refname>
6
-
<refpurpose>Specify the character encoding in which the messages from the DOMAIN message catalog will be returned</refpurpose>
6
+
<refpurpose>Specify or get the character encoding in which the messages from the DOMAIN message catalog will be returned</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>bind_textdomain_codeset</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>bind_textdomain_codeset</methodname>
13
13
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>codeset</parameter></methodparam>
14
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>codeset</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
-
With <function>bind_textdomain_codeset</function>, you can set in which
18
-
encoding will be messages from <parameter>domain</parameter> returned by
17
+
<function>bind_textdomain_codeset</function> allows to set or get the
18
+
encoding in which messages from <parameter>domain</parameter> will be returned by
19
19
<function>gettext</function> and similar functions.
20
20
</para>
21
21
</refsect1>
...
...
@@ -28,7 +28,7 @@
28
28
<term><parameter>domain</parameter></term>
29
29
<listitem>
30
30
<para>
31
-
The domain
31
+
The domain.
32
32
</para>
33
33
</listitem>
34
34
</varlistentry>
...
...
@@ -36,7 +36,8 @@
36
36
<term><parameter>codeset</parameter></term>
37
37
<listitem>
38
38
<para>
39
-
The code set
39
+
The code set.
40
+
If &null;, the currently set encoding is returned.
40
41
</para>
41
42
</listitem>
42
43
</varlistentry>
...
...
@@ -50,8 +51,40 @@
50
51
A <type>string</type> on success.
51
52
</para>
52
53
</refsect1>
53
-
</refentry>
54
54
55
+
<refsect1 role="changelog">
56
+
&reftitle.changelog;
57
+
<informaltable>
58
+
<tgroup cols="2">
59
+
<thead>
60
+
<row>
61
+
<entry>&Version;</entry>
62
+
<entry>&Description;</entry>
63
+
</row>
64
+
</thead>
65
+
<tbody>
66
+
<row>
67
+
<entry>8.0.3</entry>
68
+
<entry>
69
+
<parameter>codeset</parameter> is nullable now.
70
+
Previously, it was not possible to retrieve the currently set encoding.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+
78
+
<refsect1 role="notes">
79
+
&reftitle.notes;
80
+
<note>
81
+
<para>
82
+
The <function>bind_textdomain_codeset</function> information is maintained per process,
83
+
not per thread.
84
+
</para>
85
+
</note>
86
+
</refsect1>
87
+
</refentry>
55
88
<!-- Keep this comment at the end of the file
56
89
Local variables:
57
90
mode: sgml
58
91