explain_fread_or_die(3) [debian man page]

explain_fread_or_die(3) 				     Library Functions Manual					   explain_fread_or_die(3)

NAME

       explain_fread_or_die - binary stream input and report errors

SYNOPSIS

       #include <libexplain/fread.h>
       void explain_fread_or_die(void *ptr, size_t size, size_t nmemb, FILE *fp);

DESCRIPTION

       The  explain_fread_or_die function is used to call the fread(3) system call.  On failure an explanation will be printed to stderr, obtained
       from explain_fread(3), 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:
	      size_t how_many = explain_fread_or_die(ptr, size, nmemb, fp);

       ptr     The ptr, exactly as to be passed to the fread(3) system call.

       size    The size, exactly as to be passed to the fread(3) system call.

       nmemb   The nmemb, exactly as to be passed to the fread(3) system call.

       fp      The fp, exactly as to be passed to the fread(3) system call.

       Returns:
	       This function only returns on success, the number read or 0 on end-of-input.  On failure, prints an explanation and exits.

SEE ALSO

       fread(3)
	       binary stream input

       explain_fread(3)
	       explain fread(3) errors

       exit(2) terminate the calling process

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2008 Peter Miller

															   explain_fread_or_die(3)

FREAD(3)						   BSD Library Functions Manual 						  FREAD(3)

NAME

     fread, fwrite -- binary stream input/output

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <stdio.h>

     size_t
     fread(void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream);

     size_t
     fwrite(const void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream);

DESCRIPTION

     The function fread() reads nmemb objects, each size bytes long, from the stream pointed to by stream, storing them at the location given by
     ptr.

     The function fwrite() writes nmemb objects, each size bytes long, to the stream pointed to by stream, obtaining them from the location given
     by ptr.

RETURN VALUES

     The functions fread() and fwrite() advance the file position indicator for the stream by the number of bytes read or written.  They return
     the number of objects read or written.  If an error occurs, or the end-of-file is reached, the return value is a short object count (or
     zero).

     The function fread() does not distinguish between end-of-file and error, and callers must use feof(3) and ferror(3) to determine which
     occurred.	The function fwrite() returns a value less than nmemb only if a write error has occurred.

SEE ALSO

     read(2), write(2)

STANDARDS

     The functions fread() and fwrite() conform to ISO/IEC 9899:1990 (``ISO C90'').

BSD
								   March 8, 1994							       BSD