Cogent C API and Utilities : Version 7.2
	Cascade TextLogger Functions

`LG_Group`

LG_Group — groups a number of logs or groups together.

Syntax

#include <cogent.h>
ST_STATUS LG_Group( IP_Task*   myself, 
  IP_Task*   textlog, 
  char*   retbuf, 
  int   buflen, 
  char*   label, 
  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.
label: The name of the group to be created.
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 group in the Cascade TextLogger documentation). If the return value is ST_OK, the retbuf may not contain useful information.

Description

This function lets you group any number of logs or groups. Grouping allows you to give commands that refer to several logs at the same time, because a command specifying a group will be applied to all the logs in that group or its sub-groups.

Groups can be made recursively (ie. groups of groups). Each group must contain either groups or logs, but not both; you are not permitted to have a group consisting of groups and single logs.

This function corresponds to the Cascade TextLogger group command.

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


LG_Flush		LG_Log