Provided by: libexplain-dev_1.4.D001-8_amd64 bug

NAME

       explain_fputc - explain fputc(3) errors

SYNOPSIS

       #include <libexplain/fputc.h>
       const char *explain_fputc(int c, FILE *fp);
       const char *explain_errno_fputc(int errnum, int c, FILE *fp);
       void explain_message_fputc(char *message, int message_size, int c, FILE *fp);
       void  explain_message_errno_fputc(char *message, int message_size, int errnum, int c, FILE
       *fp);

DESCRIPTION

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

   explain_fputc
       const char *explain_fputc(int c, FILE *fp);

       The  explain_fputc  function  is used to obtain an explanation of an error returned by the
       fputc(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.

       This function is intended to be used in a fashion similar to the following example:
              if (fputc(c, fp) == EOF)
              {
                  fprintf(stderr, "%s\n", explain_fputc(c, fp));
                  exit(EXIT_FAILURE);
              }

       c       The original c, exactly as passed to the fputc(3) system call.

       fp      The original fp, exactly as passed to the fputc(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.

   explain_errno_fputc
       const char *explain_errno_fputc(int errnum, int c, FILE *fp);

       The  explain_errno_fputc function is used to obtain an explanation of an error returned by
       the  fputc(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.

       This function is intended to be used in a fashion similar to the following example:
              if (fputc(c, fp) == EOF)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_fputc(err, c, fp));
                  exit(EXIT_FAILURE);
              }

       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.

       c       The original c, exactly as passed to the fputc(3) system call.

       fp      The original fp, exactly as passed to the fputc(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.

   explain_message_fputc
       void explain_message_fputc(char *message, int message_size, int c, FILE *fp);

       The  explain_message_fputc  function  may  be  used  to  obtain an explanation of an error
       returned by the fputc(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.

       This function is intended to be used in a fashion similar to the following example:
              if (fputc(c, fp) == EOF)
              {
                  char message[3000];
                  explain_message_fputc(message, sizeof(message), c, fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       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.

       c       The original c, exactly as passed to the fputc(3) system call.

       fp      The original fp, exactly as passed to the fputc(3) system call.

   explain_message_errno_fputc
       void  explain_message_errno_fputc(char *message, int message_size, int errnum, int c, FILE
       *fp);

       The explain_message_errno_fputc function may be used to obtain an explanation of an  error
       returned  by the fputc(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.

       This function is intended to be used in a fashion similar to the following example:
              if (fputc(c, fp) == EOF)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_fputc(message, sizeof(message), err, c, fp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       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.

       c       The original c, exactly as passed to the fputc(3) system call.

       fp      The original fp, exactly as passed to the fputc(3) system call.

SEE ALSO

       fputc(3)
               output of characters

       explain_fputc_or_die(3)
               output of characters and report errors

COPYRIGHT

       libexplain version 1.4
       Copyright (C) 2008 Peter Miller

                                                                                 explain_fputc(3)