libexplain/iconv_close.h File Reference

explain iconv_close(3) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>
#include <iconv.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)
const char *	explain_iconv_close (iconv_t cd) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_iconv_close (int errnum, iconv_t cd) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_iconv_close (char *message, int message_size, iconv_t cd)
void	explain_message_errno_iconv_close (char *message, int message_size, int errnum, iconv_t cd)

---

Detailed Description

explain iconv_close(3) errors

These functions may be used to obtain explanations for errors returned by the iconv_close(3) system call.

Definition in file iconv_close.h.

---

Function Documentation

const char* explain_errno_iconv_close	(	int	errnum,
		iconv_t	cd
	)

The explain_errno_iconv_close function is used to obtain an explanation of an error returned by the iconv_close(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
cd	The original cd, exactly as passed to the iconv_close(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 errno = 0;
 if (iconv_close(cd) < 0 && errno != 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_iconv_close(err, cd));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_iconv_close_or_die function.

const char* explain_iconv_close

(

iconv_t

cd

)

The explain_iconv_close function is used to obtain an explanation of an error returned by the iconv_close(3) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

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

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 errno = 0;
 if (iconv_close(cd) < 0 && errno != 0)
 {
     explain_output_error_and_die("%s\n", explain_iconv_close(cd));
 }

The above code example is available pre\-packaged as the explain_iconv_close_or_die function.

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
 }

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);

void explain_message_errno_iconv_close	(	char *	message,
		int	message_size,
		int	errnum,
		iconv_t	cd
	)

The explain_message_errno_iconv_close function is used to obtain an explanation of an error returned by the iconv_close(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
cd	The original cd, exactly as passed to the iconv_close(3) system call.

Example:

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

 errno = 0;
 if (iconv_close(cd) < 0 && errno != 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_iconv_close(message, sizeof(message), err, cd);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_iconv_close_or_die function.

void explain_message_iconv_close	(	char *	message,
		int	message_size,
		iconv_t	cd
	)

The explain_message_iconv_close function is used to obtain an explanation of an error returned by the iconv_close(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
cd	The original cd, exactly as passed to the iconv_close(3) system call.

Example:

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

 errno = 0;
 if (iconv_close(cd) < 0 && errno != 0)
 {
     char message[3000];
     explain_message_iconv_close(message, sizeof(message), cd);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_iconv_close_or_die function.