LG_Empty

LG_Empty — specifies a place-holder string for empty data readings.

Syntax

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

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.

emptystring

The string which will replace a non-existent value when the LG_Collect style is set to fill.

Returns

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

Description

This function lets you specify a string to be written whenever there is no data available for a point. This is a global value, applied to all logs.

This function corresponds to the Cascade TextLogger empty command.