libexplain/iconv_close_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/iconv.h>
#include <libexplain/iconv_close.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_iconv_close_or_die (iconv_t cd)
int	explain_iconv_close_on_error (iconv_t cd)

---

Function Documentation

int explain_iconv_close_on_error

(

iconv_t

cd

)

The explain_iconv_close_on_error function is used to call the iconv_close(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_iconv_close(3) function.

Parameters:

cd	The cd, exactly as to be passed to the iconv_close(3) system call.

Returns:

The value returned by the wrapped iconv_close(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 errno = 0;
 if (explain_iconv_close_on_error(cd) < 0 && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 38 of file iconv_close_or_die.c.

void explain_iconv_close_or_die

(

iconv_t

cd

)

The explain_iconv_close_or_die function is used to call the iconv_close(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_iconv_close(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

cd	The cd, exactly as to be passed to the iconv_close(3) system call.

Returns:

This function only returns on success, see iconv_close(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

This function is intended to be used in a fashion similar to the following example:

 explain_iconv_close_or_die(cd);

Definition at line 27 of file iconv_close_or_die.c.