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.
Value | Meaning |
---|---|
|
Enable log archive (ephemeral logs) support. |
|
Disables ephemeral logs. |
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
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2003 R2 [desktop apps only] |
Target Platform | Windows |
Header | clfsw32.h |
Library | ClfsW32.lib |
DLL | ClfsW32.dll |