ClfsQueryLogFileInformation function (wdm.h)

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

Syntax

CLFSUSER_API NTSTATUS ClfsQueryLogFileInformation(
  [in]  PLOG_FILE_OBJECT           plfoLog,
  [in]  CLFS_LOG_INFORMATION_CLASS eInformationClass,
        PVOID                      pinfoInputBuffer,
        ULONG                      cbinfoInputBuffer,
  [out] PVOID                      pinfoBuffer,
        PULONG                     pcbInfoBuffer
);

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

pinfoInputBuffer

Optional input buffer which is required for some information classes.

cbinfoInputBuffer

Length in bytes of pinfoInputBuffer.

[out] pinfoBuffer

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.

pcbInfoBuffer

Length in bytes of the incoming information buffer.

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

See also

ClfsSetLogFileInformation