KatoLog (Windows Embedded CE 6.0)

1/6/2010

This function logs a string to the current logging level with a specified verbosity level. The verbosity value is tallied for the given level.

Syntax

BOOL KatoLog(
    HKATO hKato,
    DWORD dwVerbosity,
    LPCTSTR szFormat
);

Parameters

• hKato
  Handle to a CKato object.

• dwVerbosity
  Verbosity level of this log message. This value can be between zero and KATO_MAX_VERBOSITY.

• szFormat
  Address of ANSI or UNICODE format-control string.

Return Value

Nonzero if successful; otherwise, 0.

Remarks

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

Within each level of log, a tally is kept for each verbosity. Each time this function is called, the counter for the specified verbosity is incremented. The KatoGetVerbosityCount function can be used to query a level for its verbosity tallies. Usually particular verbosity values are associated with concepts such as pass and fail. If you structure your log in this manner, you can use the KatoGetVerbosityCount function to query the number of passes and failures that have occurred within a given level.

Each logging system on the server side has a verbosity filter, which 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. Typically a severe failing log gets a verbosity level of 0.

Requirements

See Also

Concepts

C Interface for Kato