SLOG_Irec_IsConsistent(3)

SLOG_Irec_IsConsistent3

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

Usage

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

From mpi-doc 1.2.5.3-5 in Debian 3.1 (Sarge). Parsed by carta from the page's man source.