explain_iconv_close man page

explain_iconv_close — explain iconv_close(3) errors

Synopsis

#include <libexplain/iconv_close.h>

const char *explain_iconv_close(iconv_t cd);
const char *explain_errno_iconv_close(int errnum, iconv_t cd);
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);

Description

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

explain_iconv_close

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.

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)

{

fprintf(stderr, "%s\n", explain_iconv_close(cd));

    exit(EXIT_FAILURE);
}

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

explain_errno_iconv_close

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(errno), but usually it will do much better, and indicate the underlying cause in more detail.

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

explain_message_iconv_close

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

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

explain_message_errno_iconv_close

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(errno), but usually it will do much better, and indicate the underlying cause in more detail.

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

See Also

iconv_close(3)
deallocate descriptor for character set conversion
explain_iconv_close_or_die(3)
deallocate descriptor for character set conversion and report errors

Referenced By

explain(3), explain_iconv_close_or_die(3).