Windows Dev Center

GetLogIoStatistics function

Retrieves log I/O statistics for a dedicated or multiplexed log that is associated with the specified handle. This function queries Common Log File System (CLFS) for specific types of log I/O statistics. Calling this function on a multiplexed log only associates the statistics with the underlying log.

Syntax


BOOL WINAPI GetLogIoStatistics(
  _In_      HANDLE             hLog,
  _Inout_   PVOID              pvStatsBuffer,
  _In_      ULONG              cbStatsBuffer,
  _In_      CLFS_IOSTATS_CLASS eStatsClass,
  _Out_opt_ PULONG             pcbStatsWritten
);

Parameters

hLog [in]

A handle to an open log file that CreateLogFile gets. The log handle can refer to either a dedicated or multiplexed log file.

pvStatsBuffer [in, out]

A pointer to a buffer to receive the I/O statistics.

This buffer must be at least as large as an I/O statistics packet header. For more information, see CLFS_IO_STATISTICS_HEADER.

cbStatsBuffer [in]

The size of the I/O statistics buffer pvStatsBuffer, in bytes.

If the buffer is not large enough for the statistics packet, the function fails with ERROR_MORE_DATA.

eStatsClass [in]

This parameter is not implemented at this time; it is reserved for future use.

pcbStatsWritten [out, optional]

A pointer to a variable to receive the size of the I/O statistics packet that is written to pvStatsBuffer.

This value is less than or equal to cbStatsBuffer.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, call GetLastError. The following list identifies the possible error codes:

ERROR_ACCESS_DENIED
ERROR_INSUFFICIENT_USER_BUFFER
ERROR_INVALID_BUFFER_SIZE
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_IO_DEVICE
ERROR_MORE_DATA

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

CLFS_IO_STATISTICS_HEADER
CLFS_IOSTATS_CLASS
Common Log File System Functions

 

 

Community Additions

ADD
Show:
© 2015 Microsoft