const SLOG_intvlrec_t * SLOG_Irec_FromInputStream( SLOG_STREAM *slog, int *irc )
The routine returns a pointer to the interval record of the various Bbuf in current frame buffer in the SLOG_STREAM given. The routine does NOT create new node/irec. It just simply returns a pointer to the existing one in the bi-directional linked list( an internal data structure ). If one wants to modify the content of the interval record without modification of the specified bi-directional linked node, one should use SLOG_Irec_Copy() to copy the returned record content to a new record. The routine also ADVANCES the internal pointer of the specified linked list buffer. Also, the routine does NOT gurantee the memory associated with previously _returned_ interval record be retained in the next call of the routine. So if one wants to keep interval record for future reference, one need to use SLOG_Irec_Copy() to copy the content of the interval record to another memory location __BEFORE__ calling SLOG_Irec_FromInputStream() again. The example program, slog_readtest.c shows the typical way of using this subroutine.
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().