ClfsSetLogFileInformation function (wdm.h)

Article
02/22/2024

The ClfsSetLogFileInformation routine sets metadata and state information for a specified stream and its underlying physical log.

Syntax

CLFSUSER_API NTSTATUS ClfsSetLogFileInformation(
  [in] PLOG_FILE_OBJECT           plfoLog,
  [in] CLFS_LOG_INFORMATION_CLASS eInformationClass,
  [in] PVOID                      pinfoBuffer,
  [in] ULONG                      cbBuffer
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents a CLFS stream. The caller previously obtained this pointer by calling ClfsCreateLogFile.

[in] eInformationClass

A CLFS_LOG_INFORMATION_CLASS value that specifies the class of information being set.

[in] pinfoBuffer

A pointer to a buffer that supplies the log information. The structure of this buffer varies according to the class of information specified by eInformationClass. The following table shows the relationship between the information class and the buffer type.

Value of eInformationClass	Type of buffer pointed to by pinfoBuffer
ClfsLogBasicInformation	CLFS_INFORMATION
ClfsLogBasicInformationPhysical	CLFS_INFORMATION
ClfsLogNameInformation	CLFS_LOG_NAME_INFORMATION
ClfsLogPhysicalNameInformation	CLFS_LOG_NAME_INFORMATION
ClfsLogStreamIdentifierInformation	CLFS_STREAM_ID_INFORMATION

[in] cbBuffer

The size, in bytes, of the buffer pointed to by pinfoBuffer.

Return value

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

Remarks

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