KatoSetCallback (Compact 2013)

  • Article

3/26/2014

This function configures Kato to use a callback function when logging.

Syntax

BOOL KatoSetCallback(
  LPKATOCALLBACK lpCallback,
  LPARAM lParam
);

Parameters

  • lpCallback
    Pointer to a callback routine of type KATOCALLBACK. If this parameter is NULL, then any current callback logging will be removed and no callback logging will be used.
  • lParam
    32-bit, application-defined value to be passed to the callback function.

Return Value

Nonzero if successful; otherwise, zero.

Remarks

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

Requirements

Header

kato.h

Library

kato.lib

See Also

Concepts

Common Functions for C and C++ Interfaces