explain_fclose(3)                                            explain_fclose(3)



NNAAMMEE
       explain_fclose - explain fclose(3) errors

SSYYNNOOPPSSIISS
       #include <libexplain/fclose.h>
       const char *explain_fclose(FILE *fp);
       const char *explain_errno_fclose(int errnum, FILE *fp);
       void explain_message_fclose(char *message, int message_size, FILE *fp);
       void  explain_message_errno_fclose(char *message, int message_size, int
       errnum, FILE *fp);

DDEESSCCRRIIPPTTIIOONN
       These functions may be used to obtain explanations of _f_c_l_o_s_e(3) errors.

   eexxppllaaiinn__ffcclloossee
       const char *explain_fclose(FILE * fp);

       The explain_fclose function is used to  obtain  an  explanation  of  an
       error  returned  by the _f_c_l_o_s_e(3) function.  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.

       This function is intended to be used in a fashion similar to  the  fol-
       lowing example:
              if (fclose(fp))
              {
                  fprintf(stderr, "%s\n", explain_fclose(fp));
                  exit(EXIT_FAILURE);
              }

       _f_p      The  original  fp,  exactly  as  passed to the _f_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.

       NNoottee:: This function may be of little diagnostic value, because libc may
       have destroyed any useful context, leaving nothing  for  libexplain  to
       work  with  (this  is true of glibc in particular).  For files that are
       open for writing, you will obtain  more  useful  information  by  first
       calling _f_f_l_u_s_h(3), as in the following example
              if (fflush(fp))
              {
                  fprintf(stderr, "%s\n", explain_fflush(fp));
                  exit(EXIT_FAILURE);
              }
              if (fclose(fp))
              {
                  fprintf(stderr, "%s\n", explain_fclose(fp));
                  exit(EXIT_FAILURE);
              }

   eexxppllaaiinn__eerrrrnnoo__ffcclloossee
       const char *explain_errno_fclose(int errnum, FILE * fp);

       The  explain_errno_fclose  function is used to obtain an explanation of
       an error returned by the _f_c_l_o_s_e(3) function.   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.

       This function is intended to be used in a fashion similar to  the  fol-
       lowing example:
              if (fclose(fp))
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_fclose(err, fp));
                  exit(EXIT_FAILURE);
              }

       _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.

       _f_p      The  original  fp,  exactly  as  passed to the _f_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.

       NNoottee:: This function may be of little diagnostic value, because libc may
       have destroyed any useful context, leaving nothing  for  libexplain  to
       work  with  (this  is true of glibc in particular).  For files that are
       open for writing, you will obtain  more  useful  information  by  first
       calling _f_f_l_u_s_h(3), as in the following example
              if (fflush(fp))
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_fflush(err, fp));
                  exit(EXIT_FAILURE);
              }
              if (fclose(fp))
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_fclose(err, fp));
                  exit(EXIT_FAILURE);
              }

   eexxppllaaiinn__mmeessssaaggee__ffcclloossee
       void explain_message_fclose(char *message, int message_size, FILE *fp);

       The explain_message_fclose function is used to obtain an explanation of
       an error returned by the _f_c_l_o_s_e(3) function.   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.

       This  function  is intended to be used in a fashion similar to the fol-
       lowing example:
              if (fclose(fp))
              {
                  char message[3000];
                  explain_message_fclose(message, sizeof(message), fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       _m_e_s_s_a_g_e The location in which to store the returned message.  Because a
               message  return  buffer  has  been  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.

       _f_p      The  original  fp,  exactly  as  passed to the _f_c_l_o_s_e_(_3_) system
               call.

       NNoottee:: This function may be of little diagnostic value, because libc may
       have  destroyed  any  useful context, leaving nothing for libexplain to
       work with (this is true of glibc in particular).  For  files  that  are
       open  for  writing,  you  will  obtain more useful information by first
       calling _f_f_l_u_s_h(3), as in the following example
              if (fflush(fp))
              {
                  char message[3000];
                  explain_message_fflush(message, sizeof(message), fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }
              if (fclose(fp))
              {
                  char message[3000];
                  explain_message_fclose(message, sizeof(message), fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

   eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__ffcclloossee
       void explain_message_errno_fclose(char *message, int message_size,  int
       errnum, FILE *fp);

       The explain_message_errno_fclose function is used to obtain an explana-
       tion of an error returned by the _f_c_l_o_s_e(3)  function.   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.

       This function is intended to be used in a fashion similar to  the  fol-
       lowing exameple:
              if (fclose(fp))
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_fclose(message, sizeof(message),
                      err, fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       _m_e_s_s_a_g_e The location in which to store the returned message.  Because a
               message return buffer  has  been  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.

       _f_p      The original fp, exactly as  passed  to  the  _f_c_l_o_s_e(3)  system
               call.

       NNoottee:: This function may be of little diagnostic value, because libc may
       have destroyed any useful context, leaving nothing  for  libexplain  to
       work  with  (this  is true of glibc in particular).  For files that are
       open for writing, you will obtain  more  useful  information  by  first
       calling _f_f_l_u_s_h(3), as in the following example
              if (fflush(fp))
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_fflush(message, sizeof(message),
                      err, fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }
              if (fclose(fp))
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_fclose(message, sizeof(message),
                      err, fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

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

AAUUTTHHOORR
       Written by Peter Miller <pmiller@opensource.org.au>



                                                             explain_fclose(3)
