LG_UseGMT

LG_UseGMT — sets time/date strings to GMT or local time.

Syntax

#include <cogent.h>
ST_STATUS LG_UseGMT(IP_Task*  myself,
 IP_Task*  textlog,
 char*  retbuf,
 int  buflen,
 int  usegmt,
 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.

usegmt

1 sets the time to GMT (the default), 0 sets the time to local.

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 usegmt in the Cascade TextLogger documentation). If the return value is ST_OK, the retbuf may not contain useful information.

Description

This function lets you set the time for the time and date strings of any log or group to Greenwich Mean Time or local time. If no label is specified, this command sets a global default value for all logs and groups. Any specific value always overrides the global definition, regardless of the order in the configuration file or when a command is sent.

This function corresponds to the Cascade TextLogger usegmt command.