ClfsSetLogFileInformation routine

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

Syntax


NTSTATUS ClfsSetLogFileInformation(
  _In_ PLOG_FILE_OBJECT           plfoLog,
  _In_ CLFS_LOG_INFORMATION_CLASS eInformationClass,
  _In_ PVOID                      pinfoBuffer,
  _In_ ULONG                      cbBuffer
);

Parameters

plfoLog [in]

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

eInformationClass [in]

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

pinfoBuffer [in]

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 eInformationClassType 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

 

cbBuffer [in]

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

Target platform

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

CLFS_INFORMATION
CLFS_LOG_INFORMATION_CLASS
CLFS_STREAM_ID_INFORMATION
LOG_FILE_OBJECT
ClfsCreateLogFile
ClfsQueryLogFileInformation

 

 

Send comments about this topic to Microsoft

Show: