---
name: "SLOG_SetPreviewName"
section: "3"
platform: "linux"
package: "mpi-doc"
version: "1.2.5.3-5"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/SLOG_SetPreviewName"
---

# SLOG\_SetPreviewName(3)

Set the filename of the to be copied Preview file and Copy the file's content to the SLOG file

## 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().\

## LOCATION