TerminateReadLog function (clfsw32.h)

Terminates a read context. This function frees system-allocated resources associated with the specified read context. Do not attempt to read log records after calling this function; you will receive indeterminate results.

Syntax

CLFSUSER_API BOOL TerminateReadLog(
  PVOID pvCursorContext
);

Parameters

pvCursorContext

A pointer to a read context that is returned by ReadLogRecord or ReadLogRestartArea.

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

Remarks

It is important to deallocate unused read contexts. Failure to call this function causes resource leaks.

Requirements

   
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

ReadLogRecord

ReadLogRestartArea