SetLogArchiveMode function (clfsw32.h)

Enables or disables log archive support for a specified log.

Syntax

CLFSUSER_API BOOL SetLogArchiveMode(
  [in] HANDLE                hLog,
  [in] CLFS_LOG_ARCHIVE_MODE eMode
);

Parameters

[in] hLog

A handle to the log that is obtained from CreateLogFile.

[in] eMode

Specifies whether to make the log ephemeral. This parameter can be one of the following values.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, call GetLastError.

Requirements

See also

Common Log File System Functions