.lf 1 ./man/man3/explain_readlink.3
.\"
.\" libexplain - Explain errno values returned by libc functions
.\" Copyright (C) 2008, 2009, 2011 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 <http://www.gnu.org/licenses/>.
.\"
.ds n) explain_readlink
.cp 0  \" Solaris defaults to ''.cp 1'', sheesh.
.TH explain_readlink 3
.SH NAME
explain_readlink \- explain readlink(2) errors
.if require_index \{
.\}
.SH SYNOPSIS
#include <libexplain/readlink.h>
.sp 0.3
const char *explain_readlink(const char *pathname, char *data,
size_t data_size);
.br
const char *explain_errno_readlink(int errnum, const char *pathname,
char *data, size_t data_size);
.br
void explain_message_readlink(char *message, int message_size,
const char *pathname, char *data, size_t data_size);
.br
void explain_message_errno_readlink(char *message, int message_size,
int errnum, const char *pathname, char *data, size_t data_size);
.SH DESCRIPTION
These functions may be used to obtain explanations for
errors returned by the \f[I]readlink\fP(2) system call.
.\" ----------------------------------------------------
.SS explain_readlink
const char *explain_readlink(const char *pathname, char *data,
size_t data_size);
.PP
The \f[B]explain_readlink\fP function is
used to obtain an explanation of an error returned by the \f[I]readlink\fP(2)
system call.  The least the message will contain is the
value of \f[CW]strerror(errno)\fP, 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 CW
.nf
if (readlink(pathname, data, data_size) < 0)
{
    fprintf(stderr, "%s\en", explain_readlink(pathname, data, data_size));
    exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]pathname\fP
The original pathname, exactly as passed to the \f[I]readlink\fP(2) system call.
.TP 8n
\f[I]data\fP
The original data, exactly as passed to the \f[I]readlink\fP(2) system call.
.TP 8n
\f[I]data_size\fP
The original data_size, exactly as passed to the \f[I]readlink\fP(2)
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_errno_readlink
const char *explain_errno_readlink(int errnum, const char *pathname,
char *data, size_t data_size);
.PP
The \f[B]explain_errno_readlink\fP function
is used to obtain an explanation of an error returned by
the \f[I]readlink\fP(2) system call.
The least the message will contain is the value of
\f[CW]strerror(errnum)\fP, 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 CW
.nf
if (readlink(pathname, data, data_size) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\en", explain_errno_readlink(err, pathname, data,
        data_size));
    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]readlink\fP(2) system call.
.TP 8n
\f[I]data\fP
The original data, exactly as passed to the \f[I]readlink\fP(2) system call.
.TP 8n
\f[I]data_size\fP
The original data_size, exactly as passed to the \f[I]readlink\fP(2)
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_readlink
void explain_message_readlink(char *message, int message_size,
const char *pathname, char *data, size_t data_size);
.PP
The \f[B]explain_message_readlink\fP
function may be used to  obtain an explanation of an error
returned by the
\f[I]readlink\fP(2) system call.
The least the message will contain is the value of
\f[CW]strerror(errno)\fP, 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 CW
.nf
if (readlink(pathname, data, data_size) < 0)
{
    char message[3000];
    explain_message_readlink(message, sizeof(message), pathname, data,
        data_size);
    fprintf(stderr, "%s\en", message);
    exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]message\fP
The location in which to store the returned message.
If a suitable message return buffer is supplied, this
function 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]readlink\fP(2) system call.
.TP 8n
\f[I]data\fP
The original data, exactly as passed to the \f[I]readlink\fP(2) system call.
.TP 8n
\f[I]data_size\fP
The original data_size, exactly as passed to the \f[I]readlink\fP(2)
system call.
.\" ----------------------------------------------------
.SS explain_message_errno_readlink
void explain_message_errno_readlink(char *message, int message_size,
int errnum, const char *pathname, char *data, size_t data_size);
.PP
The \f[B]explain_message_errno_readlink\fP
function may be used to obtain an explanation of an error
returned by the
\f[I]readlink\fP(2) system call.
The least the message will contain is the value of
\f[CW]strerror(errnum)\fP, 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 CW
.nf
if (readlink(pathname, data, data_size) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_readlink(message, sizeof(message), err, pathname,
        data, data_size);
    fprintf(stderr, "%s\en", message);
    exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]message\fP
The location in which to store the returned message.
If a suitable message return buffer is supplied, this
function 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]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]readlink\fP(2) system call.
.TP 8n
\f[I]data\fP
The original data, exactly as passed to the \f[I]readlink\fP(2) system call.
.TP 8n
\f[I]data_size\fP
The original data_size, exactly as passed to the \f[I]readlink\fP(2)
system call.
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]readlink\fP(2)
blah blah blah
.TP 8n
\f[I]explain_readlink_or_die\fP(3)
blah blah blah  and report errors
.\" ----------------------------------------------------
.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 269 ./man/man3/explain_readlink.3
.if n .ds C) (C)
.if t .ds C) \(co
libexplain version \*(v)
.br
Copyright \*(C) 2008 Peter Miller