msgcat.c File Reference

#include <config.h>
#include <stddef.h>
#include <stdlib.h>
#include <isc/magic.h>
#include <isc/msgcat.h>
#include <isc/util.h>

Go to the source code of this file.

Data Structures
struct	isc_msgcat
Defines
#define	MSGCAT_MAGIC   ISC_MAGIC('M', 'C', 'a', 't')
#define	VALID_MSGCAT(m)   ISC_MAGIC_VALID(m, MSGCAT_MAGIC)
Functions
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

Author:

Principal Author: Bob Halley

Definition in file msgcat.c.

---

Define Documentation

#define MSGCAT_MAGIC   ISC_MAGIC('M', 'C', 'a', 't')

Definition at line 53 of file msgcat.c.

Referenced by isc_msgcat_open().

#define VALID_MSGCAT

(

m

)

ISC_MAGIC_VALID(m, MSGCAT_MAGIC)

Definition at line 54 of file msgcat.c.

Referenced by isc_msgcat_close(), and isc_msgcat_get().

---

Function Documentation

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().

---