Share via

KatoBeginLevel

  • Article

This function begins a new level in the logging hierarchy.

INT KatoBeginLevel(
  HKATO hKato, 
  DWORD dwLevelID, 
  LPCTSTR szFormat 
);

Parameters

  • hKato
    Handle to a CKato object.
  • 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 that must associate each line of log to a particular test or component.
  • szFormat
    Address of ANSI or UNICODE format-control string.

Return Values

Returns the new logging level if successful; otherwise, -1.

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.

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 KatoEndLevel function. All open levels will automatically be closed during the destruction of a CKato object.

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

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Kato.h.
Link Library: Kato.lib.

See Also

C Interface for Kato | KatoEndLevel | KatoGetCurrentLevel

 Last updated on Friday, October 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.