TerminateLogArchive function (clfsw32.h)

Deallocates system resources that are allocated originally for a log archive context by PrepareLogArchive.

Syntax

CLFSUSER_API BOOL TerminateLogArchive(
  [in] CLFS_LOG_ARCHIVE_CONTEXT pvArchiveContext
);

Parameters

[in] pvArchiveContext

The archive context that is obtained from PrepareLogArchive.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. The following error code is possible:

Remarks

Failure to call this function after archiving completes results in a resource leak.

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

See also

Common Log File System Functions

PrepareLogArchive