ClfsQueryLogFileInformation routine

The ClfsQueryLogFileInformation routine returns metadata and state information for a specified CLFS stream or its underlying physical log or both.

Syntax


NTSTATUS  ClfsQueryLogFileInformation(
  _In_    PLOG_FILE_OBJECT           plfoLog,
  _In_    CLFS_LOG_INFORMATION_CLASS eInformationClass,
  _Out_   PVOID                      pinfoBuffer,
  _Inout_ PULONG                     pcbBuffer
);

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 value from the CLFS_LOG_INFORMATION_CLASS enumeration that specifies the type of information being requested.

pinfoBuffer [out]

A pointer to a buffer that receives the log information. The structure of this buffer depends on the value of eInformationClass. The following table shows the relationship between the information class and the data type of the buffer.

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

 

pcbBuffer [in, out]

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

Return value

ClfsQueryLogFileInformation 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

Desktop

Version

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

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

Clfs.lib

DLL

Clfs.sys

IRQL

<= APC_LEVEL

See also

ClfsSetLogFileInformation

 

 

Send comments about this topic to Microsoft

Show: