NAME

kjb_fread - Reads a specifed number of bytes from a stream.

SYNOPSIS

#include "l/l_sys_io.h"

Example compile flags (system dependent):
  -DLINUX_X86_64 -DLINUX_X86_64_OPTERON  -DGNU_COMPILER 
   -I/home/kobus/include
   -L/home/kobus/misc/load/linux_x86_64_opteron -L/usr/lib/x86_64-linux-gnu
  -lKJB                               -lfftw3  -lgsl -lgslcblas -ljpeg  -lSVM -lstdc++                    -lpthread -lSLATEC -lg2c    -lacml -lacml_mv -lblas -lg2c      -lncursesw 


long kjb_fread
(
	FILE *fp,
	void *buff,
	size_t len
);

DESCRIPTION

This is essentially a front end for fread, but there are some differences. First, the arguments are different. The file pointer is first, and the size arguments are combined. Second, the error reporting is more consistent with the rest of the library. This routine can only read up to LONG_MAX bytes at a time. If the number of bytes requested is more than MIN_OF(LONG_MAX, SSIZE_MAX), this routine returns ERROR. The routine kjb_read() can be used to read up the number of bytes that can stored in size_t. This function is not re-entrant (i.e., not thread-safe).

RETURNS

On success kjb_fread returns the number of bytes read. On end of file. EOF is returned. On failure ERROR is returned and an error message is set. If the I/O is non blocking, then WOULD_BLOCK may also be returned. Finally, depending on the type of signal handling in place, INTERRUPTED may also be returned.

DISCLAIMER

This software is not adequatedly tested. It is recomended that results are checked independantly where appropriate.

AUTHOR

Kobus Barnard

DOCUMENTER