TerminateReadLog function

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


BOOL WINAPI TerminateReadLog(
  _In_ PVOID pvCursorContext
);

Parameters

pvCursorContext [in]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_INVALID_READ_CONTEXT
ERROR_IO_DEVICE

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]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

Common Log File System Functions
ReadLogRecord
ReadLogRestartArea

 

 

Community Additions

ADD
Show: