msgcat.h File Reference

The ISC Message Catalog aids internationalization of applications by allowing messages to be retrieved from locale-specific files instead of hardwiring them into the application. This allows translations of messages appropriate to the locale to be supplied without recompiling the application. More...

#include <isc/lang.h>
#include <isc/types.h>

Go to the source code of this file.

Defines
#define	ISC_MSGCAT_H   1
Functions
ISC_LANG_BEGINDECLS void	isc_msgcat_open (const char *name, isc_msgcat_t **msgcatp)
	Open a message catalog.
void	isc_msgcat_close (isc_msgcat_t **msgcatp)
	Close a message catalog.
const char *	isc_msgcat_get (isc_msgcat_t *msgcat, int set, int message, const char *default_text)
	Get message 'message' from message set 'set' in 'msgcat'. If it is not available, use 'default_text'.

---

Detailed Description

The ISC Message Catalog aids internationalization of applications by allowing messages to be retrieved from locale-specific files instead of hardwiring them into the application. This allows translations of messages appropriate to the locale to be supplied without recompiling the application.

Notes:

• It's very important that message catalogs work, even if only the default_text can be used.

MP:

• The caller must ensure appropriate synchronization of isc_msgcat_open() and isc_msgcat_close(). isc_msgcat_get() ensures appropriate synchronization.

Reliability:

• No anticipated impact.

Resources:

• TBS

• Security: No anticipated impact.

• Standards: None.

Definition in file msgcat.h.

---

Define Documentation

#define ISC_MSGCAT_H   1

Definition at line 21 of file msgcat.h.

---

Function Documentation

ISC_LANG_BEGINDECLS void isc_msgcat_open	(	const char *	name,
		isc_msgcat_t **	msgcatp
	)

Open a message catalog.

Notes:

• If memory cannot be allocated or other failures occur, *msgcatp will be set to NULL. If a NULL msgcat is given to isc_msgcat_get(), the default_text will be returned, ensuring that some message text will be available, no matter what's going wrong.

Requires:

• 'name' is a valid string.

• msgcatp != NULL && *msgcatp == NULL

Definition at line 57 of file msgcat.c.

References isc_msgcat::magic, MSGCAT_MAGIC, and REQUIRE.

Referenced by open_msgcat().

void isc_msgcat_close

(

isc_msgcat_t **

msgcatp

)

Close a message catalog.

Notes:

• Any string pointers returned by prior calls to isc_msgcat_get() are invalid after isc_msgcat_close() has been called and must not be used.

Requires:

• *msgcatp is a valid message catalog or is NULL.

Ensures:

• All resources associated with the message catalog are released.

• *msgcatp == NULL

Definition at line 87 of file msgcat.c.

References free(), isc_msgcat::magic, REQUIRE, and VALID_MSGCAT.

const char* isc_msgcat_get	(	isc_msgcat_t *	msgcat,
		int	set,
		int	message,
		const char *	default_text
	)

Get message 'message' from message set 'set' in 'msgcat'. If it is not available, use 'default_text'.

Requires:

• 'msgcat' is a valid message catalog or is NULL.

• set > 0

• message > 0

• 'default_text' is a valid string.

Definition at line 111 of file msgcat.c.

References REQUIRE, and VALID_MSGCAT.

Referenced by build_msghdr_send(), default_callback(), default_fatal_callback(), deschedule(), dispatch(), doio_send(), dumpstats(), getbuf4(), handle_signal(), initialize_action(), internal_accept(), internal_current(), internal_current4(), isc__taskmgr_create(), isc__timermgr_create(), isc__timermgr_destroy(), isc_commandline_parse(), isc_condition_waituntil(), isc_error_runtimecheck(), isc_interfaceiter_create(), isc_lex_gettoken(), isc_lib_initmsgcat(), isc_log_doit(), isc_mem_stats(), isc_netaddr_format(), isc_result_totext(), isc_sockaddr_format(), isc_sockaddr_getport(), isc_sockaddr_hash(), isc_sockaddr_pf(), isc_sockaddr_setport(), schedule(), setup_watcher(), task_shutdown(), and try_proto().

---