SLOG_PROF_Open(3)

SLOG_PROF_Open3

Creates the slog display profile, slog_prof_t, needed to write the to the disk.

Usage

int SLOG_PROF_Open( SLOG_STREAM  *slog )

Modified input variables

slog

- pointer to the SLOG_STREAM where SLOG Display Profile is located.

Modified output variables

returned value

- integer return status.

Include file needed

slog_profile.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.