CKato::Comment (Compact 2013)

  • Article

3/26/2014

This method logs a string to the current logging level with a specified verbosity level. The verbosity value will not be tallied for the given level.

Syntax

BOOL Comment(
  DWORD dwVerbosity,
  LPCTSTR szFormat
);

Parameters

  • dwVerbosity
    Verbosity level of this log message. This value can be between 0 and KATO_MAX_VERBOSITY.
  • szFormat
    Address of ANSI or UNICODE format-control string.

Return Value

Nonzero if successful; otherwise, zero.

Remarks

One or more optional arguments can also be used in this method. The number and type of argument parameters depends on the corresponding format-control specifications in the szFormat parameter.

The CKato::Comment and CKato::CommentV methods operate similarly to the CKato::Log and CKato::LogV methods, with the exception that the CKato::Comment and CKato::CommentV methods do not record the verbosity level.

Each logging system on the server side has a verbosity filter that filters out all logs with verbosity values greater than the current filter value for that system. For this reason, applications should structure their logging so that the most critical logs get the lowest verbosity level.

Requirements

Header

kato.h

Library

kato.lib

See Also

Concepts

CKato (C++)