NAME
explain_remove - explain remove(2) errors
SYNOPSIS
#include <libexplain/remove.h>
const char *explain_remove(const char *pathname);
const char *explain_errno_remove(int errnum, const char *pathname);
void explain_message_remove(char *message, int message_size, const char
*pathname);
void explain_message_errno_remove(char *message, int message_size, int
errnum, const char *pathname);
DESCRIPTION
These functions may be used to obtain explanations for errors returned
by the remove(2) system call.
explain_remove
const char *explain_remove(const char *pathname);
The explain_remove function may be used to describe errors returned by
the remove() 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 (remove(pathname) < 0)
{
fprintf(stderr, "%s\n", explain_remove(pathname));
exit(EXIT_FAILURE);
}
pathname
The original pathname, exactly as passed to the remove(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_remove
const char *explain_errno_remove(int errnum, const char *pathname);
The explain_errno_remove function may be used to describe errors
returned by the remove() 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 (remove(pathname) < 0)
{
int err = errno;
fprintf(stderr, "%s\n", explain_remove(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
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.
pathname
The original pathname, exactly as passed to the remove(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_removevoid explain_message_remove(char *message,
int message_size, const char *pathname);
The explain_message_remove function may be used to describe errors
returned by the remove() 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 (remove(pathname) < 0)
{
char message[3000];
explain_message_remove(message, sizeof(message), pathname);
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.
pathname
The original pathname, exactly as passed to the remove(2)
system call.
explain_message_errno_remove
void explain_message_errno_remove(char *message, int message_size, int
errnum, const char *pathname);
The explain_message_errno_remove function may be used to describe
errors returned by the remove() 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 (remove(pathname) < 0)
{
int err = errno;
char message[3000];
explain_message_errno_remove(message, sizeof(message), err, pathname);
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.
pathname
The original pathname, exactly as passed to the remove(2)
system call.
SEE ALSO
remove delete a name and possibly the file it refers to
explain_remove_or_die
delete a file and report errors
COPYRIGHT
libexplain version 0.19
Copyright (C) 2008 Peter Miller
explain_remove(3)