SLOG_Irec_IsConsistent

Check if the specified Interval record's length, bytesize, is consistent with what it contains.

Synopsis


int SLOG_Irec_IsConsistent( const SLOG_intvlrec_t *irec )

Unmodified Input Variables

irec - constant SLOG_intvlrec_t pointer to be checked

Modified Output variables

returned value - integer return status

Usage Notes on this subroutine

This routine is mainly used for debugging purposes.

Include File Needed

slog.h

Notes on SLOG return status code

There are 5 allowed SLOG returned status codes. They include SLOG_SUCCESS, SLOG_FAIL and SLOG_EOF. Their actual values are defined in slog.h

SLOG_SUCCESS is returned when no error is encountered.

SLOG_FAIL is returned when error is encounted.

SLOG_EOF is returned when End of file is encounted.

There are also SLOG_TRUE and SLOG_FALSE which are sued as boolean values, in particular they are used in boolean functions which are usually named as IsXXXXX(), AreXXXXX() and HasXXXXX().

Location:../src/slog_irec_common.c