SetLogArchiveMode function

Enables or disables log archive support for a specified log.

Syntax


BOOL WINAPI SetLogArchiveMode(
  _In_ HANDLE                hLog,
  _In_ CLFS_LOG_ARCHIVE_MODE eMode
);

Parameters

hLog [in]

A handle to the log that is obtained from CreateLogFile.

eMode [in]

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

ValueMeaning
ClfsLogArchiveEnabled

Enable log archive (ephemeral logs) support.

ClfsLogArchiveDisabled

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

ClfsW32.h

Library

ClfsW32.lib

DLL

ClfsW32.dll

See also

Common Log File System Functions

 

 

Community Additions

ADD
Show: