2 * Copyright (C) 1999-2001 Internet Software Consortium.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
9 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
10 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
11 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
13 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
14 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
15 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: msgcat.h,v 1.8 2001/01/09 21:57:13 bwelling Exp $ */
21 #define ISC_MSGCAT_H 1
30 * Message catalogs aid internationalization of applications by allowing
31 * messages to be retrieved from locale-specific files instead of
32 * hardwiring them into the application. This allows translations of
33 * messages appropriate to the locale to be supplied without recompiling
37 * It's very important that message catalogs work, even if only the
38 * default_text can be used.
41 * The caller must ensure appropriate synchronization of
42 * isc_msgcat_open() and isc_msgcat_close(). isc_msgcat_get()
43 * ensures appropriate synchronization.
46 * No anticipated impact.
52 * No anticipated impact.
63 #include <isc/types.h>
72 isc_msgcat_open(const char *name, isc_msgcat_t **msgcatp);
74 * Open a message catalog.
78 * If memory cannot be allocated or other failures occur, *msgcatp
79 * will be set to NULL. If a NULL msgcat is given to isc_msgcat_get(),
80 * the default_text will be returned, ensuring that some message text
81 * will be available, no matter what's going wrong.
85 * 'name' is a valid string.
87 * msgcatp != NULL && *msgcatp == NULL
91 isc_msgcat_close(isc_msgcat_t **msgcatp);
93 * Close a message catalog.
97 * Any string pointers returned by prior calls to isc_msgcat_get() are
98 * invalid after isc_msgcat_close() has been called and must not be
103 * *msgcatp is a valid message catalog or is NULL.
107 * All resources associated with the message catalog are released.
113 isc_msgcat_get(isc_msgcat_t *msgcat, int set, int message,
114 const char *default_text);
116 * Get message 'message' from message set 'set' in 'msgcat'. If it
117 * is not available, use 'default_text'.
121 * 'msgcat' is a valid message catalog or is NULL.
127 * 'default_text' is a valid string.
132 #endif /* ISC_MSGCAT_H */