SLOG_Irec_GetMinRec

Retrieve the fields for a bare minimal Interval Record

Synopsis


int SLOG_Irec_GetMinRec( const SLOG_intvlrec_t   *intvlrec,
                               SLOG_rectype_t    *rectype,
                               SLOG_evttype_t    *evttype,
                               SLOG_bebit_t      *bebit_0,
                               SLOG_bebit_t      *bebit_1,
                               SLOG_starttime_t  *starttime,
                               SLOG_duration_t   *duration,
                               SLOG_nodeID_t     *node_id,
                               SLOG_cpuID_t      *cpu_id,
                               SLOG_threadID_t   *thread_id,
                               SLOG_where_t      *where )

Unmodified Input Variables

intvlrec - pointer to the internal Interval record to be retrieved.

Modified Output Variables

rectype - pointer to the interval record's rectype field which determines if the record is a FIXED record or VARIABLE record, this in turns will determine the number of association and the number of sets of MPI call arguments.
evttype - pointer to interval record's event type field.
bebit_0 - pointer to interval record's first bebit.
bebit_1 - pointer to interval record's second bebit.
starttime - pointer to interval record's start time.
duration - pointer to interval record's life time.
node_id - pointer to interval record's node ID.
thread_id - pointer to interval record's thread ID.
where - pointer to interval record's where integer pointer.

Modified Output Variables

returned value - integer return status.

Usage Notes on this subroutine

Since the subroutine copies all the fixed fields of the specified record to the input variables, the record must be non-empty. The subroutine can only be called __After__ retrieving the interval record from the SLOG file.

Include File Needed

slog.h

Notes on SLOG return status code

There are 3 allowed SLOG returned status codes. They are 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.

Location:../src/slog_irec_read.c