Man Linux: Main Page and Category List

NAME

       explain_closedir - explain closedir(3) errors

SYNOPSIS

       #include <libexplain/closedir.h>
       const char *explain_closedir(DIR *dir);
       const char *explain_errno_closedir(int errnum, DIR *dir);
       void  explain_message_closedir(char  *message,  int  message_size,  DIR
       *dir);
       void explain_message_errno_closedir(char  *message,  int  message_size,
       int errnum, DIR *dir);

DESCRIPTION

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

   explain_closedir
       const char *explain_closedir(DIR *dir);

       The explain_closedir function is used to obtain an  explanation  of  an
       error  returned  by the closedir(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 (closedir(dir) < 0)
              {
                  fprintf(stderr, "%s\n", explain_closedir(dir));
                  exit(EXIT_FAILURE);
              }

       dir     The  original  dir, exactly as passed to the closedir(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_closedir
       const char *explain_errno_closedir(int errnum, DIR *dir);

       The explain_errno_closedir function is used to obtain an explanation of
       an error returned by  the  closedir(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 (closedir(dir) < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_closedir(err, dir));
                  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.

       dir     The original dir, exactly as passed to the  closedir(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_closedir
       void  explain_message_closedir(char  *message,  int  message_size,  DIR
       *dir);

       The  explain_message_closedir  function  may  be  used  to   obtain  an
       explanation of an error returned by the closedir(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 (closedir(dir) < 0)
              {
                  char message[3000];
                  explain_message_closedir(message, sizeof(message), dir);
                  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.

       dir     The original dir, exactly as passed to the  closedir(3)  system
               call.

   explain_message_errno_closedir
       void  explain_message_errno_closedir(char  *message,  int message_size,
       int errnum, DIR *dir);

       The explain_message_errno_closedir function may be used  to  obtain  an
       explanation  of  an error returned by the closedir(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 (closedir(dir) < 0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_closedir(message, sizeof(message), err, dir);
                  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.

       dir     The original dir, exactly as passed to the  closedir(3)  system
               call.

SEE ALSO

       closedir(3)
               close a directory

       explain_closedir_or_die(3)
               close a directory and report errors

COPYRIGHT

       libexplain version 0.19
       Copyright (C) 2008 Peter Miller

                                                           explain_closedir(3)