CloseAndResetLogFile function

Resets the log file and then shuts the log. This nullifies any client restart areas and resets the base log sequence number (LSN) for the log. You do not need to close a log stream handle after calling this function.

Syntax


BOOL WINAPI CloseAndResetLogFile(
  _In_  HANDLE hLog
);

Parameters

hLog [in]

A handle to a dedicated or multiplexed log.

This handle is returned by a successful call to CreateLogFile. It is invalidated on successful completion of the call. No other operations that use this handle, or a derivative of this handle, can be called after this function has returned.

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. The following list identifies the possible error codes:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE

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
CreateLogFile

 

 

Community Additions

ADD
Show:
© 2014 Microsoft