ClfsDeleteLogByPointer function (wdm.h)

Article
02/22/2024

The ClfsDeleteLogByPointer routine marks a CLFS stream for deletion.

Syntax

CLFSUSER_API NTSTATUS ClfsDeleteLogByPointer(
  [in] PLOG_FILE_OBJECT plfoLog
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents an open instance of the stream to be deleted. The caller previously obtained this pointer by calling ClfsCreateLogFile.

Return value

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

Remarks

ClfsDeleteLogByPointer marks a stream for deletion but does not close the log file object pointed to by plfoLog. To close a log file object, call ClfsCloseLogFileObject. A stream marked for deletion is deleted after all log file objects associated with the stream are closed.

A CLFS stream marked for deletion will refuse subsequent requests to open the stream.

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

Requirements

Requirement	Value
Minimum supported client	Available in Windows Server 2003 R2, Windows Vista, and later versions of Windows.
Target Platform	Desktop
Header	wdm.h (include Wdm.h)
Library	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL