ClfsTerminateReadLog function (wdm.h)

The ClfsTerminateReadLog routine invalidates a specified read context after freeing resources associated with the context.

Syntax

CLFSUSER_API NTSTATUS ClfsTerminateReadLog(
  [in] PVOID pvCursorContext
);

Parameters

[in] pvCursorContext

A pointer to the read context to be invalidated. The caller previously obtained this pointer by calling ClfsReadLogRecord or ClfsReadRestartArea.

Return value

ClfsTerminateReadLog returns STATUS_SUCCESS if it succeeds; otherwise, it returns one of the error codes defined in Ntstatus.h.

Remarks

Warning

Failure to call this routine can lead to memory leaks, premature exhaustion of log I/O blocks, and increased frequency of log flushes. Attempting to use pvCursorContext after it is freed is equivalent to accessing freed memory and can lead to unexpected behavior.

For an explanation of CLFS concepts and terminology, see Common Log File System.

Requirements

Requirement	Value
Target Platform	Desktop
Header	wdm.h (include Wdm.h)
Library	Clfs.lib
DLL	Clfs.sys
IRQL	IRQL <= APC_LEVEL

See also

ClfsReadLogRecord

ClfsReadRestartArea