SLOG_Irec_SetMinRec

Set the fields for a bare minimal Interval Record

Synopsis


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

Modified Input Variables

intvlrec - pointer to the internal interval record to be modified.

Unmodified Input Variables

rectype - 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 - interval record's event type field.
bebit_0 - interval record's first bebit.
bebit_1 - interval record's second bebit.
starttime - interval record's start time.
duration - interval record's life time.
node_id - interval record's node ID.
cpu_id - interval record's cpu ID.
thread_id - interval record's thread ID.
where - interval record's where integer pointer.

Modified Output Variables

returned value - integer return status.

Usage Notes on this subroutine

The subroutine initializes an allocated internal interval record data structure. So the routine must be called before appending the record to 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_write.c