Cogent C API and Utilities : Version 7.2
	Cascade TextLogger Functions

`LG_Cache`

LG_Cache — controls how frequently data is written.

Syntax

#include <cogent.h>
ST_STATUS LG_Cache( IP_Task*   myself, 
  IP_Task*   textlog, 
  char*   retbuf, 
  int   buflen, 
  int   cached, 
  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.
cached: Any non-0 value sets caching on (the default). A value of 0 turns off caching.
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 cache in the Cascade TextLogger documentation). If the return value is ST_OK, the retbuf may not contain useful information.

Description

This function lets you determine how frequently data is written. When caching is on (cached is set to 0, the default), data is written in blocks, according to your default C library file buffer implementation. When caching is off (any non-zero value), each line of output is immediately flushed from the buffer to the file.

If the Cascade TextLogger is started with the -F option, this function is ignored because there is no possibility of caching; all data is immediately flushed to the file.

This function corresponds to the Cascade TextLogger cache command.

`ST_STATUS LG_Cache(`	IP_Task*	`myself`,
	IP_Task*	`textlog`,
	char*	`retbuf`,
	int	`buflen`,
	int	`cached`,
	int	`nlabels`,
	char**	`labels)`;