libexplain  1.4.D001
Functions
libexplain/fflush.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/buffer/errno/fflush.h>
#include <libexplain/common_message_buffer.h>
#include <libexplain/fflush.h>

Go to the source code of this file.

Functions

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)

Function Documentation

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(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:
errnumThe 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.
fpThe 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 function.

Definition at line 36 of file fflush.c.

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.

Parameters:
fpThe 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 function.

Definition at line 29 of file fflush.c.

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(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:
messageThe location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_sizeThe size in bytes of the location in which to store the returned message.
errnumThe 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.
fpThe 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 function.

Definition at line 57 of file fflush.c.

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(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:
messageThe location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_sizeThe size in bytes of the location in which to store the returned message.
fpThe 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 function.

Definition at line 50 of file fflush.c.