CKato::BeginLevel (Windows Embedded CE 6.0)

1/6/2010

This method begins a new level in the logging hierarchy.

Syntax

INT BeginLevel(
  DWORD dwLevelID,
  LPCTSTR szFormat
);

Parameters

• dwLevelID
  Identifier value to be associated with all the output generated within the new level. This value is usually used to uniquely identify a test case or group of log output. This value may be used by log systems such as SQL to store the log output, or by a post-parser, which is needed to associate each line of log to a particular test or test case.

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

Return Value

This method returns the new logging level if successful; otherwise, -1.

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.

Logging levels are usually used to group sets of tests or comments. They provide a mechanism of organizing logging output into a hierarchical format. Levels should be closed when finished by calling the CKato::EndLevel method or CKato::EndLevelV method. All open levels will automatically be closed during the destruction of a CKato object.

This method fails if the current level is already at the maximum level defined by KATO_MAX_LEVEL.

Requirements

See Also

Concepts

CKato (C++)