Platform SDK: Performance Monitoring

PdhUpdateLogFileCatalog

The PdhUpdateLogFileCatalog function synchronizes the information in the log file catalog with the performance data in the log file.

PDH_STATUS PdhUpdateLogFileCatalog(
  HLOG hLog             
);

Parameters

hLog
[in] A handle to the log file containing the file catalog to be updated.

Return Values

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, the return value is a PDH error status defined in PDHMsg.h. The following are possible error values.

Error value Description
PDH_NOT_IMPLEMENTED A handle to a CSV or TSV log file was specified. These log file types do not have catalogs.
PDH_UNKNOWN_LOG_FORMAT A handle to a log file with an unknown format was specified.
PDH_INVALID_HANDLE An invalid handle was specified.

Remarks

The log file catalog serves as an index to the performance data records in the log file, providing for faster searches for individual records in the file.

Catalogs should be updated when the data collection process is complete and the log file has been closed. The catalog can be updated during data collection, but doing this may disrupt the process of logging the performance data because updating the catalogs can be time consuming.

Perfmon, CSV, and TSV log files do not have catalogs. Specifying a handle to these log file types will result in a return value of PDH_NOT_IMPLEMENTED.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Pdh.h.
  Library: Use Pdh.lib.

See Also

PdhUpdateLog, PdhGetLogFileSize