libexplain/explanation.h File Reference

#include <libexplain/ac/limits.h>
#include <libexplain/ac/sys/param.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Data Structures
struct	explain_explanation_t
Typedefs
typedef struct explain_explanation_t	explain_explanation_t
Functions
void	explain_explanation_init (explain_explanation_t *exp, int errnum)
void	explain_explanation_assemble (explain_explanation_t *exp, explain_string_buffer_t *result)
void	explain_explanation_assemble_gai (explain_explanation_t *exp, explain_string_buffer_t *result)
void	explain_explanation_assemble_netdb (explain_explanation_t *exp, explain_string_buffer_t *result)

---

Typedef Documentation

typedef struct explain_explanation_t explain_explanation_t

Definition at line 28 of file explanation.h.

---

Function Documentation

void explain_explanation_assemble	(	explain_explanation_t *	exp,
		explain_string_buffer_t *	result
	)

The explain_explanation_assemble function may be used to carefully glue the problem statement and the explanation together, using internationalization, for which localizations may re-arrange the order.

Parameters:

exp	The explanation of interest. You are expected to have filled out the two string buffers already.
result	where to print the resulting completed explanation.

Definition at line 26 of file assemble.c.

void explain_explanation_assemble_gai	(	explain_explanation_t *	exp,
		explain_string_buffer_t *	result
	)

The explain_explanation_assemble_gai function may be used to carefully glue the problem statement and the explanation together, using internationalization, for which localizations may re-arrange the order. (specific to getaddrinfo)

Parameters:

exp	The explanation of interest. You are expected to have filled out the two string buffers already.
result	where to print the resulting completed explanation.

Definition at line 26 of file assemble_gai.c.

void explain_explanation_assemble_netdb	(	explain_explanation_t *	exp,
		explain_string_buffer_t *	result
	)

The explain_explanation_assemble_netdb function may be used to carefully glue the problem statement and the explanation together, using internationalization, for which localizations may re-arrange the order. (Specific to gethostbyname, et al.)

Parameters:

exp	The explanation of interest. You are expected to have filled out the two string buffers already.
result	where to print the resulting completed explanation.

Definition at line 28 of file assemble_netdb.c.

void explain_explanation_init	(	explain_explanation_t *	exp,
		int	errnum
	)

The explain_explanation_init function is used to initialize an explanation struct for use.

Parameters:

exp	The explanation struct of interest
errnum	The errno value provoking this message

Definition at line 24 of file init.c.