libexplain/dirfd.h File Reference

explain dirfd(3) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>
#include <dirent.h>

Go to the source code of this file.

Functions
int	explain_dirfd_or_die (DIR *dir) LIBEXPLAIN_WARN_UNUSED_RESULT
int	explain_dirfd_on_error (DIR *dir) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_dirfd (DIR *dir) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_dirfd (int errnum, DIR *dir) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_dirfd (char *message, int message_size, DIR *dir)
void	explain_message_errno_dirfd (char *message, int message_size, int errnum, DIR *dir)

---

Detailed Description

explain dirfd(3) errors

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

Definition in file dirfd.h.

---

Function Documentation

const char* explain_dirfd

(

DIR *

dir

)

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

Parameters:

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

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = dirfd(dir);
 if (result < 0)
 {
     fprintf(stderr, "%s\n", explain_dirfd(dir));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_dirfd_or_die function.

int explain_dirfd_on_error

(

DIR *

dir

)

The explain_dirfd_on_error function is used to call the dirfd(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_dirfd(3) function.

Parameters:

dir	The dir, exactly as to be passed to the dirfd(3) system call.

Returns:

The value returned by the wrapped dirfd(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = explain_dirfd_on_error(dir);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

int explain_dirfd_or_die

(

DIR *

dir

)

The explain_dirfd_or_die function is used to call the dirfd(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_dirfd(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

dir	The dir, exactly as to be passed to the dirfd(3) system call.

Returns:

This function only returns on success, see dirfd(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = explain_dirfd_or_die(dir);

const char* explain_errno_dirfd	(	int	errnum,
		DIR *	dir
	)

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

Parameters:

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 dirfd(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.

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = dirfd(dir);
 if (result < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_dirfd(err, dir));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_dirfd_or_die function.

void explain_message_dirfd	(	char *	message,
		int	message_size,
		DIR *	dir
	)

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

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

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 dirfd(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = dirfd(dir);
 if (result < 0)
 {
     char message[3000];
     explain_message_dirfd(message, sizeof(message), dir);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_dirfd_or_die function.

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

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

Parameters:

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 dirfd(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 int result = dirfd(dir);
 if (result < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_dirfd(message, sizeof(message), err, dir);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_dirfd_or_die function.