NAME
SLOG_SetPreviewName - Set the filename of the to be copied Preview file and Copy the file's content to the SLOG file
SYNOPSIS
int SLOG_SetPreviewName( SLOG_STREAM *slog, const char *pview_filename )
UNMODIFIED INPUT PARAMETER
- pview_filename
-
- pointer to the characters of the Preview's filename. If no file is supplied, "/dev/null" should be supplied to avoid checking of file SLOG_Preview.txt in working directory.
MODIFIED INPUT PARAMETER
- slog
-
- pointer to the SLOG_STREAM where interval records are stored.
MODIFIED OUTPUT PARAMETER
- returned value
-
- integer return status code.
INCLUDE FILE NEED
slog_preview.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().