explain_rmdir(3)					     Library Functions Manual						  explain_rmdir(3)

NAME

       explain_rmdir - explain rmdir(2) errors

SYNOPSIS

       #include <libexplain/rmdir.h>
       const char *explain_rmdir(const char *pathname);
       const char *explain_errno_rmdir(int errnum, const char  pathname);
       void explain_message_rmdir(char *message, int message_size, const char *pathname);
       void explain_message_errno_rmdir(char *message, int message_size, int errnum, const char *pathname);

DESCRIPTION

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

   explain_rmdir
       const char *explain_rmdir(const char *pathname);

       The  explain_rmdir  function may be used to describe errors returned by the rmdir() 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 (rmdir(pathname) < 0)
	      {
		  fprintf(stderr, "%s
", explain_rmdir(pathname));
		  exit(EXIT_FAILURE);
	      }

       pathname
	       The original pathname, exactly as passed to the rmdir(2) 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_rmdir
       const char *explain_errno_rmdir(int errnum, const char *pathname);

       The explain_errno_rmdir function may be used to describe errors returned by the rmdir() 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 (rmdir(pathname) < 0)
	      {
		  int err = errno;
		  fprintf(stderr, "%s
", explain_rmdir(err, pathname));
		  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 neces-
	       sary 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.

       pathname
	       The original pathname, exactly as passed to the rmdir(2) 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_rmdir
       void explain_message_rmdir(char *message, int message_size, const char *pathname);

       The  explain_message_rmdir function may be used to describe errors returned by the rmdir() 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 (rmdir(pathname) < 0)
	      {
		  char message[3000];
		  explain_message_rmdir(message, sizeof(message), pathname);
		  fprintf(stderr, "%s
", 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.

       pathname
	       The original pathname, exactly as passed to the rmdir(2) system call.

   explain_message_errno_rmdir
       void explain_message_errno_rmdir(char *message, int message_size, int errnum, const char *pathname);

       The  explain_message_errno_rmdir  function  may be used to describe errors returned by the rmdir() 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 (rmdir(pathname) < 0)
	      {
		  int err = errno;
		  char message[3000];
		  explain_message_errno_rmdir(message, sizeof(message), err, pathname);
		  fprintf(stderr, "%s
", 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 neces-
	       sary 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.

       pathname
	       The original pathname, exactly as passed to the rmdir(2) system call.

SEE ALSO

       rmdir   delete a directory

       explain_rmdir_or_die
	       delete a directory and report errors

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2008 Peter Miller

																  explain_rmdir(3)