File: bind_textdomain_codeset.3.html

package info (click to toggle)
gettext 0.18.1.1-9
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 70,628 kB
  • sloc: ansic: 333,297; sh: 51,604; makefile: 8,355; perl: 4,181; lisp: 3,357; yacc: 665; java: 613; cs: 578; sed: 369; objc: 337; cpp: 325; awk: 80; tcl: 63; pascal: 11; php: 8
file content (165 lines) | stat: -rw-r--r-- 5,074 bytes parent folder | download | duplicates (2)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!-- Creator     : groff version 1.18.1 -->
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>BIND_TEXTDOMAIN_CODESET</title>
</head>
<body>

<h1 align=center>BIND_TEXTDOMAIN_CODESET</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#RETURN VALUE">RETURN VALUE</a><br>
<a href="#ERRORS">ERRORS</a><br>
<a href="#BUGS">BUGS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>bind_textdomain_codeset &minus; set encoding of message
translations</p>
</td>
</table>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre><b>#include &lt;libintl.h&gt;

char * bind_textdomain_codeset (const char *</b> <i>domainname</i><b>,
                                const char *</b> <i>codeset</i><b>);
</b></pre>
</td>
</table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->

<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The <b>bind_textdomain_codeset</b> function sets the
output codeset for message catalogs for domain
<i>domainname</i>.</p>
<!-- INDENTATION -->
<p>A message domain is a set of translatable <i>msgid</i>
messages. Usually, every software package has its own
message domain.</p>
<!-- INDENTATION -->
<p>By default, the <b>gettext</b> family of functions
returns translated messages in the locale&rsquo;s character
encoding, which can be retrieved as
<b>nl_langinfo(CODESET)</b>. The need for calling
<b>bind_textdomain_codeset</b> arises for programs which
store strings in a locale independent way (e.g. UTF-8) and
want to avoid an extra character set conversion on the
returned translated messages.</p>
<!-- INDENTATION -->
<p><i>domainname</i> must be a non-empty string.</p>
<!-- INDENTATION -->
<p>If <i>codeset</i> is not NULL, it must be a valid
encoding name which can be used for the <b>iconv_open</b>
function. The <b>bind_textdomain_codeset</b> function sets
the output codeset for message catalogs belonging to domain
<i>domainname</i> to <i>codeset</i>. The function makes
copies of the argument strings as needed.</p>
<!-- INDENTATION -->
<p>If <i>codeset</i> is NULL, the function returns the
previously set codeset for domain <i>domainname</i>. The
default is NULL, denoting the locale&rsquo;s character
encoding.</p>
</td>
</table>
<a name="RETURN VALUE"></a>
<h2>RETURN VALUE</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>If successful, the <b>bind_textdomain_codeset</b>
function returns the current codeset for domain
<i>domainname</i>, after possibly changing it. The resulting
string is valid until the next
<b>bind_textdomain_codeset</b> call for the same
<i>domainname</i> and must not be modified or freed. If a
memory allocation failure occurs, it sets <b>errno</b> to
<b>ENOMEM</b> and returns NULL. If no codeset has been set
for domain <i>domainname</i>, it returns NULL.</p>
</td>
</table>
<a name="ERRORS"></a>
<h2>ERRORS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The following error can occur, among others:</p>
</td>
</table>
<!-- TABS -->
<table width="100%" border=0 rules="none" frame="void"
       cols="5" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="8%">

<p><b>ENOMEM</b></p>
</td>
<td width="13%"></td>
<td width="41%">

<p>Not enough memory available.</p>
</td>
<td width="24%">
</td>
</table>
<a name="BUGS"></a>
<h2>BUGS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The return type ought to be <b>const char *</b>, but is
<b>char *</b> to avoid warnings in C code predating ANSI
C.</p>
</td>
</table>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>gettext</b>(3), <b>dgettext</b>(3),
<b>dcgettext</b>(3), <b>ngettext</b>(3),
<b>dngettext</b>(3), <b>dcngettext</b>(3),
<b>textdomain</b>(3), <b>nl_langinfo</b>(3),
<b>iconv_open</b>(3)</p>
</td>
</table>
<hr>
</body>
</html>