File Manager

Editing File: /usr/share/doc/gettext-devel-0.19.8.1/bind_textdomain_codeset.3.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
 h1 { text-align: center }
</style>
<title>BIND_TEXTDOMAIN_CODESET</title>

</head>
<body>

<h1 align="center">BIND_TEXTDOMAIN_CODESET</h1>

<a href="#NAME">NAME</a> 
<a href="#SYNOPSIS">SYNOPSIS</a> 
<a href="#DESCRIPTION">DESCRIPTION</a> 
<a href="#RETURN VALUE">RETURN VALUE</a> 
<a href="#ERRORS">ERRORS</a> 
<a href="#BUGS">BUGS</a> 
<a href="#SEE ALSO">SEE ALSO</a>

<hr>

bind_textdomain_codeset
&minus; set encoding of message translations

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>

#include
&lt;libintl.h&gt;

char *
bind_textdomain_codeset (const char *
domainname, 
const char * codeset);

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>

The
bind_textdomain_codeset function sets the output
codeset for message catalogs for domain
domainname.

A message
domain is a set of translatable msgid messages.
Usually, every software package has its own message
domain.

By default, the
gettext family of functions returns translated
messages in the locale&rsquo;s character encoding, which can
be retrieved as nl_langinfo(CODESET). The need for
calling bind_textdomain_codeset 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.

domainname
must be a non-empty string.

If
codeset is not NULL, it must be a valid encoding name
which can be used for the iconv_open function. The
bind_textdomain_codeset function sets the output
codeset for message catalogs belonging to domain
domainname to codeset. The function makes
copies of the argument strings as needed.

If
codeset is NULL, the function returns the previously
set codeset for domain domainname. The default is
NULL, denoting the locale&rsquo;s character encoding.

<h2>RETURN VALUE
<a name="RETURN VALUE"></a>
</h2>

If successful,
the bind_textdomain_codeset function returns the
current codeset for domain domainname, after possibly
changing it. The resulting string is valid until the next
bind_textdomain_codeset call for the same
domainname and must not be modified or freed. If a
memory allocation failure occurs, it sets errno to
ENOMEM and returns NULL. If no codeset has been set
for domain domainname, it returns NULL.

<h2>ERRORS
<a name="ERRORS"></a>
</h2>

The following
error can occur, among others:

ENOMEM</td>
<td width="2%"></td>
<td width="43%">

Not enough memory available.</td>
<td width="35%">
</td></tr>
</table>

The return type
ought to be const char *, but is char * to
avoid warnings in C code predating ANSI C.

gettext(3),
dgettext(3), dcgettext(3), ngettext(3),
dngettext(3), dcngettext(3),
textdomain(3), nl_langinfo(3),
iconv_open(3)
<hr>
</body>
</html>

Back to Directory File Manager