LG_Flush

LG_Flush — flushes all buffered output.

Syntax

#include <cogent.h>
ST_STATUS LG_Flush(IP_Task*  myself,
 IP_Task*  textlog,
 char*  retbuf,
 int  buflen,
 int  nlabels,
 char**  labels);

Arguments

myself

A pointer to this task's IP_Task structure normallly generated by a call to IP_NserveInit.

textlog

A pointer to the Cascade TextLogger's IP_Task structure, normally generated by a call to IP_TaskFindName.

retbuf

A pointer to a character buffer to hold the return from the call.

buflen

The length of retbuf, in bytes.

nlabels

The number of labels (log or group names) referenced in the labels argument.

labels

An array of char*, each of which is a pointer to a string containing a log or group name.

Returns

ST_OK on success. Otherwise ST_ERROR, and the retbuf will contain a more detailed error message (see flush in the Cascade TextLogger documentation). If the return value is ST_OK, the retbuf may not contain useful information.

Description

This function attempts to log any collected data to the cache. If data is not being cached (as determined by the LG_Cache function or the cache command), the LG_Flush function will cause data to be flushed to file or standard output.

This function corresponds to the Cascade TextLogger flush command.