ClfsTerminateReadLog

ClfsTerminateReadLog routine

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

Syntax


NTSTATUS ClfsTerminateReadLog(
  _In_ PVOID pvCursorContext
);

Parameters

pvCursorContext [in]

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

Target platform

Desktop

Version

Available in Windows Server 2003 R2, Windows Vista, and later versions of Windows.

Header

Wdm.h (include Wdm.h)

Library

Clfs.lib

DLL

Clfs.sys

IRQL

<= APC_LEVEL

See also

ClfsReadLogRecord
ClfsReadRestartArea

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft