libexplain  1.4.D001
Functions
libexplain/fclose_or_die.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/fcntl.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/fclose.h>
#include <libexplain/fflush.h>
#include <libexplain/output.h>
#include <libexplain/stream_to_fildes.h>

Go to the source code of this file.

Functions

static int open_for_writing (FILE *fp)
int explain_fclose_on_error (FILE *fp)
void explain_fclose_or_die (FILE *fp)

Function Documentation

int explain_fclose_on_error ( FILE *  fp)

The explain_fclose_on_error function is used to call the fclose(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fclose(3) function.

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

 if (explain_fclose_on_error(fp) < 0)
 {
     ...cope with error
     ...no need to print error message
 }
Parameters:
fpThe fp, exactly as to be passed to the fclose(3) system call.
Returns:
The value returned by the wrapped fclose(3) system call.

Definition at line 54 of file fclose_or_die.c.

void explain_fclose_or_die ( FILE *  fp)

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

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

Parameters:
fpThe fp, exactly as to be passed to the fclose(3) system call.
Returns:
This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 93 of file fclose_or_die.c.

static int open_for_writing ( FILE *  fp) [static]

Definition at line 31 of file fclose_or_die.c.