NAME
SLOG_PROF_Open - Creates the SLOG Display Profile, SLOG_prof_t, needed to write the to the disk.
SYNOPSIS
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().