explain_iconv_close(3)                                  explain_iconv_close(3)



NNAAMMEE
       explain_iconv_close - explain _i_c_o_n_v___c_l_o_s_e(3) errors

SSYYNNOOPPSSIISS
       #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);

DDEESSCCRRIIPPTTIIOONN
       These  functions may be used to obtain explanations for errors returned
       by the _i_c_o_n_v___c_l_o_s_e(3) system call.

   eexxppllaaiinn__iiccoonnvv__cclloossee
       const char *explain_iconv_close(iconv_t cd);

       The eexxppllaaiinn__iiccoonnvv__cclloossee function is used to obtain an explanation of an
       error returned by the _i_c_o_n_v___c_l_o_s_e(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  _e_r_r_n_o global variable will be used to obtain the error value to be
       decoded.

       _c_d      The original cd, exactly as passed to the _i_c_o_n_v___c_l_o_s_e(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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

       EExxaammppllee:: 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
       _e_x_p_l_a_i_n___i_c_o_n_v___c_l_o_s_e___o_r___d_i_e(3) function.

   eexxppllaaiinn__eerrrrnnoo__iiccoonnvv__cclloossee
       const char *explain_errno_iconv_close(int errnum, iconv_t cd);

       The eexxppllaaiinn__eerrrrnnoo__iiccoonnvv__cclloossee function is used to obtain an explanation
       of  an error returned by the _i_c_o_n_v___c_l_o_s_e(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.

       _e_r_r_n_u_m  The  error value to be decoded, usually obtained from the _e_r_r_n_o
               global variable just before this function is  called.  This  is
               necessary  if you need to call aannyy code between the system call
               to be explained and this function, because many libc  functions
               will alter the value of _e_r_r_n_o.

       _c_d      The original cd, exactly as passed to the _i_c_o_n_v___c_l_o_s_e(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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

       EExxaammppllee::  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
       _e_x_p_l_a_i_n___i_c_o_n_v___c_l_o_s_e___o_r___d_i_e(3) function.

   eexxppllaaiinn__mmeessssaaggee__iiccoonnvv__cclloossee
       void explain_message_iconv_close(char *message, int message_size,
       iconv_t cd);

       The eexxppllaaiinn__mmeessssaaggee__iiccoonnvv__cclloossee function is used to obtain an  explana-
       tion of an error returned by the _i_c_o_n_v___c_l_o_s_e(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 _e_r_r_n_o global variable will be used to obtain the error value to  be
       decoded.

       _m_e_s_s_a_g_e The location in which to store the returned message. If a suit-
               able message return buffer is supplied, this function is thread
               safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The  size  in  bytes  of  the  location  in  which to store the
               returned message.

       _c_d      The original cd, exactly as passed to the _i_c_o_n_v___c_l_o_s_e(3) system
               call.

       EExxaammppllee::  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
       _e_x_p_l_a_i_n___i_c_o_n_v___c_l_o_s_e___o_r___d_i_e(3) function.

   eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__iiccoonnvv__cclloossee
       void explain_message_errno_iconv_close(char *message, int message_size,
       int errnum, iconv_t cd);

       The eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__iiccoonnvv__cclloossee function is  used  to  obtain  an
       explanation  of  an  error  returned by the _i_c_o_n_v___c_l_o_s_e(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.

       _m_e_s_s_a_g_e The location in which to store the returned message. If a suit-
               able message return buffer is supplied, this function is thread
               safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The size in bytes  of  the  location  in  which  to  store  the
               returned message.

       _e_r_r_n_u_m  The  error value to be decoded, usually obtained from the _e_r_r_n_o
               global variable just before this function is  called.  This  is
               necessary  if you need to call aannyy code between the system call
               to be explained and this function, because many libc  functions
               will alter the value of _e_r_r_n_o.

       _c_d      The original cd, exactly as passed to the _i_c_o_n_v___c_l_o_s_e(3) system
               call.

       EExxaammppllee:: 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
       _e_x_p_l_a_i_n___i_c_o_n_v___c_l_o_s_e___o_r___d_i_e(3) function.

SSEEEE AALLSSOO
       _i_c_o_n_v___c_l_o_s_e(3)
               deallocate descriptor for character set conversion

       _e_x_p_l_a_i_n___i_c_o_n_v___c_l_o_s_e___o_r___d_i_e(3)
               deallocate  descriptor  for character set conversion and report
               errors

CCOOPPYYRRIIGGHHTT
       libexplain version 1.4
       Copyright (C) 2013 Peter Miller



                                                        explain_iconv_close(3)
