Partager via

KatoFlush

  • Article

This function configures the network data-flushing mode or allows for an immediate flush.

BOOL KatoFlush(
  KATO_FLUSH_TYPE flushType 
);

Parameters

  • flushType
    Type of data flushing that should be used when logging across the network. See the Remarks section for possible values.

Return Values

Nonzero if successful; otherwise, zero.

Remarks

This function is used to control how the Kato client sends data to the CETK server. When data is flushed, the client waits for the server to acknowledge that all data has been received. The following values are allowed for flushType:

  • KATO_FLUSH_ON

    All logging calls will not return until data has reached the server.

  • KATO_FLUSH_OFF

    Data might be queued by network layer before being sent to server.

  • KATO_FLUSH_NOW

    Any current data queued by the network layer will be immediately flushed.

The default value is KATO_FLUSH_OFF, which provides the best performance. KATO_FLUSH_ON can be useful when logging on an unstable OS that could possibly crash while data is still being queued by the network layer. This mode can significantly lower performance. If you set the value to KATO_FLUSH_NOW, the application performs a single flush to ensure that all data has been flushed before continuing on.

**Note   **Currently, flushing is not supported in Kato.

Requirements

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

See Also

Kato Logging Engine

 Last updated on Friday, October 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.