Edit

Share via

ClfsGetIoStatistics function (wdm.h)

  • Article

The ClfsGetIoStatistics routine returns I/O statistics for a specified CLFS log.

Syntax

CLFSUSER_API NTSTATUS ClfsGetIoStatistics(
  [in]            PLOG_FILE_OBJECT   plfoLog,
  [in, out]       PVOID              pvStatsBuffer,
  [in]            ULONG              cbStatsBuffer,
  [in]            CLFS_IOSTATS_CLASS eStatsClass,
  [out, optional] PULONG             pcbStatsWritten
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents a CLFS stream. The I/O statistics will be collected for the stream's underlying log on stable storage. The caller previously obtained this pointer by calling ClfsCreateLogFile.

[in, out] pvStatsBuffer

A pointer to a CLFS_IO_STATISTICS structure that receives the I/O statistics data.

[in] cbStatsBuffer

The size, in bytes, of the buffer pointed to by pvStatsBuffer. This parameter must be at least sizeof(CLFS_IO_STATISTICS_HEADER). If this parameter is less than sizeof(CLFS_IO_STATISTICS), pvStatsBuffer will receive only a portion of the available I/O statistics.

[in] eStatsClass

This parameter is reserved for future use.

[out, optional] pcbStatsWritten

A pointer to a ULONG-typed variable that receives the number of bytes actually written to pvStatsBuffer. This parameter can be NULL.

Return value

ClfsGetIoStatistics 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

See also

ClfsCreateLogFile