.lf 1 ./man/man3/explain_opendir.3 .\" .\" libexplain - Explain errno values returned by libc functions .\" Copyright (C) 2008-2010 Peter Miller .\" Written by Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU .\" General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see . .\" .TH explain_opendir 3 .SH NAME explain_opendir \- explain opendir(3) errors .if require_index \{ .\} .SH SYNOPSIS const char *explain_opendir(const char *pathname); .br const char *explain_errno_opendir(int errnum, const char *pathname); int errnum, const char *pathname); .br void explain_message_opendir(char *message, int message_size, .br void explain_message_errno_opendir(char *message, int message_size, const char *pathname); .SH DESCRIPTION These functions may be used to explain \f[I]opendir\fP(3) errors. .\" ------------------------------------------------------------------------ .SS explain_opendir const char *explain_opendir(const char *pathname); .PP The explain_opendir function is used to obtain an explanation of an error returned by the \f[I]opendir\fP(3) function. 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. .PP The \f[I]errno\fP global variable will be used to obtain the error value to be decoded. .PP This function is intended to be used in a fashion similar to the following example: .RS .ft CR .nf DIR *dp = opendir(pathname); if (!dp) { fprintf(stderr, "%s\en", explain_opendir(pathname)); exit(EXIT_FAILURE); } .fi .ft R .RE .TP 8n \f[I]pathname\fP The original pathname, exactly as passed to the \f[I]opendir\fP(3) system call. .TP 8n 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. .PP \f[B]Note:\fP This function is \fBnot\fP thread safe, because it shares a return buffer across all threads, and many other functions in this library. .\" ------------------------------------------------------------------------ .SS explain_errno_opendir const char *explain_errno_opendir(int errnum, const char *pathname); int errnum, const char *pathname); .PP The explain_errno_opendir function is used to obtain an explanation of an error returned by the \f[I]opendir\fP(3) function. 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. .PP This function is intended to be used in a fashion similar to the following example: .RS .ft CR .nf DIR *dp = opendir(pathname); if (!dp) { int errnum = errno; const char *message = explain_errno_opendir(errnum, pathname); fprintf(stderr, "%s\en", message); exit(EXIT_FAILURE); } .fi .ft R .RE .TP 8n \f[I]errnum\fP The error value to be decoded, usually obtained from the \f[I]errno\fP global variable just before this function is called. This is necessary if you need to call \f[B]any\fP code between the system call to be explained and this function, because many libc functions will alter the value of \f[I]errno\fP. .TP 8n \f[I]pathname\fP The original pathname, exactly as passed to the \f[I]opendir\fP(3) system call. .TP 8n 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. .PP \f[B]Note:\fP This function is \f[B]not\fP thread safe, because it shares a return buffer across all threads, and many other functions in this library. .\" ------------------------------------------------------------------------ .SS explain_message_opendir void explain_message_opendir(char *message, int message_size, const char *pathname); .PP The explain_message_opendir function is used to obtain an explanation of an error returned by the \f[I]opendir\fP(3) function. 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. .PP The \f[I]errno\fP global variable will be used to obtain the error value to be decoded. .PP This function is intended to be used in a fashion similar to the following example: .RS .ft CR .nf DIR *dp = opendir(pathname); if (!dp) { char message[3000]; explain_message_opendir(message, sizeof(message), pathname); fprintf(stderr, "%s\en", message); exit(EXIT_FAILURE); } .ft R .fi .RE .TP 8n \f[I]message\fP The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe if the buffer is thread safe. .TP 8n \f[I]message_size\fP The size in bytes of the location in which to store the returned message. .TP 8n \f[I]pathname\fP The original pathname, exactly as passed to the \f[I]opendir\fP(3) system call. .\" ------------------------------------------------------------------------ .SS explain_message_errno_opendir void explain_message_errno_opendir(char *message, int message_size, const char *pathname); .PP The explain_message_errno_opendir function is used to obtain an explanation of an error returned by the \f[I]opendir\fP(3) function. 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. .PP This function is intended to be used in a fashion similar to the following example: .RS .nf .ft CR DIR *dp = opendir(pathname); if (!dp); { int err = errno; char message[3000]; explain_message_errno_opendir(message, sizeof(message), err, pathname); fprintf(stderr, '%s\en', message); exit(EXIT_FAILURE); } .ft R .fi .RE .TP 8n \f[I]message\fP The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe if the buffer is thread safe. .br \f[I]message_size\fP The size in bytes of the location in which to store the returned message. .TP 8n \f[I]errnum\fP The error value to be decoded, usually obtained from the \f[I]errno\fP global variable just before this function is called. This is necessary if you need to call \f[B]any\fP code between the system call to be explained and this function, because many libc functions will alter the value of \f[I]errno\fP. .TP 8n \f[I]pathname\fP The original pathname, exactly as passed to the \f[I]opendir\fP(3) system call. .\" ------------------------------------------------------------------------ .SH COPYRIGHT .lf 1 ./etc/version.so .ds v) 1.4 .ds V) 1.4.D001 .ds Y) 2008, 2009, 2010, 2011, 2012, 2013, 2014 .lf 214 ./man/man3/explain_opendir.3 .if n .ds C) (C) .if t .ds C) \(co libexplain version \*(v) .br Copyright \*(C) 2008 Peter Miller .SH AUTHOR Written by Peter Miller