Debian Codegraph @

deps/libneon/src/ne_i18n.h

raw
1 /*
2 Internationalization of neon
3 Copyright (C) 2005-2006, Joe Orton <[email protected]>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
18 MA 02111-1307, USA
19
20 */
21
22 #ifndef NE_I18N_H
23 #define NE_I18N_H
24
25 #include "ne_defs.h"
26
27 NE_BEGIN_DECLS
28
29 /* Initialize translated error messages within neon. If 'encoding' is
30 * non-NULL, it specifies the character encoding for the generated
31 * translated strings. If it is NULL, the appropriate character
32 * encoding for the locale will be used.
33 *
34 * This call is only strictly necessary if either:
35 *
36 * a) neon has been installed into a different prefix than the
37 * gettext() implementation on which it depends for i18n purposes, or
38 *
39 * b) the caller requires that translated messages are in a particular
40 * character encoding.
41 *
42 * If ne_i18n_init() is never called, the message catalogs will not be
43 * found if case (a) applies (and so English error messages will be
44 * used), and will use the default character encoding specified by the
45 * process locale. The library will otherwise operate correctly.
46 *
47 * Note that the encoding used is a process-global setting and so
48 * results may be unexpected if other users of neon within the process
49 * call ne_i18n_init() with a different encoding parameter.
50 */
51 void ne_i18n_init(const char *encoding);
52
53 NE_END_DECLS
54
55 #endif /* NE_I18N_H */