KATOCALLBACKSTRUCT (Windows Embedded CE 6.0)

1/6/2010

This structure stores logging information.

Syntax

typedef struct _KATOCALLBACKSTRUCT {
  LPARAM lParam;
  HKATO hKato;
  DWORD dwThreadID;
  DWORD dwTickCount;
  DWORD dwLevel;
  DWORD dwLevelID;
  DWORD dwVerbosity;
  LPCTSTR szLog;
} KATOCALLBACKSTRUCT, *LPKATOCALLBACKSTRUCT;

Members

• lParam
  Application-defined value given in the KatoSetCallback function.

• hKato
  Handle to the CKato object that invoked the callback. You can cast the HKATO return value to a CKato pointer when using the C++ interface.

• dwThreadID
  Thread identifier of the thread that generated the log string.

• dwTickCount
  Clock tick count at the time the log was generated.

• dwLevel
  Level depth of the current log string.

• dwLevelID
  Level identifier that the current log string belongs to.

• dwVerbosity
  Verbosity level of the current log string specified by szLog.

• szLog
  Text string that is being output by the CKato object. This string does not contain any leading white space, carriage returns, or line feeds.

Remarks

An application can define a callback function of type LPKATOCALLBACK and then call the KatoSetCallback function with a pointer to this function. This callback function will then be called with a pointer to a KATOCALLBACKSTRUCT structure every time a line of log output is generated within the given process. A callback is often used by test shell applications to locally capture or monitor all the output generated by the test code calling the CKato routines.

The text contained in szLog does not contain any leading white space, carriage returns, or line feeds. If the application needs to display the text, it should indent the text by the amount specified in dwLevel to show the level of hierarchy.

Requirements

See Also

Concepts

Common Structures for C and C++ Interfaces