NAME
explain_fflush - explain fflush(3) errors
SYNOPSIS
#include <libexplain/fflush.h>
const char *explain_fflush(FILE *fp);
const char *explain_errno_fflush(int errnum, FILE *fp);
void explain_message_fflush(char *message, int message_size, FILE *fp);
void explain_message_errno_fflush(char *message, int message_size, int
errnum, FILE *fp);
DESCRIPTION
These functions may be used to obtain explanations for errors returned
by the fflush(3) system call.
explain_fflush
const char *explain_fflush(FILE *fp);
The explain_fflush function is used to obtain an explanation of an
error returned by the fflush(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.
fp The original fp, exactly as passed to the fflush(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:
if (fflush(fp) < 0)
{
fprintf(stderr, "%s\n", explain_fflush(fp));
exit(EXIT_FAILURE);
}
The above code example is available pre-packaged as the
explain_fflush_or_die(3) function.
explain_errno_fflush
const char *explain_errno_fflush(int errnum, FILE *fp);
The explain_errno_fflush function is used to obtain an explanation of
an error returned by the fflush(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.
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.
fp The original fp, exactly as passed to the fflush(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:
if (fflush(fp) < 0)
{
int err = errno;
fprintf(stderr, "%s\n", explain_errno_fflush(err, fp));
exit(EXIT_FAILURE);
}
The above code example is available pre-packaged as the
explain_fflush_or_die(3) function.
explain_message_fflush
void explain_message_fflush(char *message, int message_size, FILE *fp);
The explain_message_fflush function is used to obtain an explanation of
an error returned by the fflush(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.
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.
fp The original fp, exactly as passed to the fflush(3) system
call.
Example: This function is intended to be used in a fashion similar to
the following example:
if (fflush(fp) < 0)
{
char message[3000];
explain_message_fflush(message, sizeof(message), fp);
fprintf(stderr, "%s\n", message);
exit(EXIT_FAILURE);
}
The above code example is available pre-packaged as the
explain_fflush_or_die(3) function.
explain_message_errno_fflush
void explain_message_errno_fflush(char *message, int message_size, int
errnum, FILE *fp);
The explain_message_errno_fflush function is used to obtain an
explanation of an error returned by the fflush(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.
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.
fp The original fp, exactly as passed to the fflush(3) system
call.
Example: This function is intended to be used in a fashion similar to
the following example:
if (fflush(fp) < 0)
{
int err = errno;
char message[3000];
explain_message_errno_fflush(message, sizeof(message), err,
fp);
fprintf(stderr, "%s\n", message);
exit(EXIT_FAILURE);
}
The above code example is available pre-packaged as the
explain_fflush_or_die(3) function.
SEE ALSO
fflush(3)
flush a stream
explain_fflush_or_die(3)
flush a stream and report errors
COPYRIGHT
libexplain version 0.19
Copyright (C) 2009 Peter Miller
explain_fflush(3)