KatoBeginLevelV (Compact 2013)

3/26/2014

This function begins a new level in the logging hierarchy and appends the specified arguments to the log.

Syntax

INT KatoBeginLevelV(
  HKATO hKato,
  DWORD dwLevelID,
  LPCTSTR szFormat, 
    va_list pArgs
);

Parameters

• hKato
  Handle to a CKato object.

• dwLevelID
  Identifier value to be associated with all the output that is generated within the new level. This value is typically used to uniquely identify a test case or group of output logs. 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 test case.

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

• pArgs
  Pointer to a list of arguments. The number and type of argument parameters depend on the corresponding format-control specifications in the szFormat parameter.

Return Value

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

Remarks

You typically use logging levels to group sets of tests or comments. They provide a mechanism to organize logging output into a hierarchical format. You must close the levels when the tests are finished by calling the KatoEndLevel or KatoEndLevelV function. All open levels are automatically 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

See Also

Concepts

C Interface for Kato