File Manager

Editing File: /usr/share/doc/gettext-devel-0.19.8.1/bindtextdomain.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>BINDTEXTDOMAIN</title>

</head>
<body>

<h1 align="center">BINDTEXTDOMAIN</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>

bindtextdomain
&minus; set directory containing message catalogs

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

#include
&lt;libintl.h&gt;

char *
bindtextdomain (const char * domainname, const
char * dirname);

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

The
bindtextdomain function sets the base directory of
the hierarchy containing message catalogs for a given
message domain.

A message
domain is a set of translatable msgid messages.
Usually, every software package has its own message domain.
The need for calling bindtextdomain arises because
packages are not always installed with the same prefix as
the &lt;libintl.h&gt; header and the libc/libintl
libraries.

Message
catalogs will be expected at the pathnames
dirname/locale/category/domainname.mo,
where locale is a locale name and category is
a locale facet such as LC_MESSAGES.

domainname
must be a non-empty string.

If
dirname is not NULL, the base directory for message
catalogs belonging to domain domainname is set to
dirname. The function makes copies of the argument
strings as needed. If the program wishes to call the
chdir function, it is important that dirname
be an absolute pathname; otherwise it cannot be guaranteed
that the message catalogs will be found.

If
dirname is NULL, the function returns the previously
set base directory for domain domainname.

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

If successful,
the bindtextdomain function returns the current base
directory for domain domainname, after possibly
changing it. The resulting string is valid until the next
bindtextdomain 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.

<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), realpath(3)
<hr>
</body>
</html>

Back to Directory File Manager