| Cogent C API and Utilities : Version 6.4 | ||
|---|---|---|
 | Cascade TextLogger Functions |  |
| Cogent C API and Utilities : Version 6.4 | ||
|---|---|---|
| | Cascade TextLogger Functions | |
#include <cogent.h>
ST_STATUS LG_Collect(IP_Task* myself, IP_Task* textlog, char* retbuf, int buflen, char* style, int nlabels, char** labels );
A pointer to this task's IP_Task structure normallly generated by a call to IP_NserveInit.
A pointer to the Cascade TextLogger's IP_Task structure, normally generated by a call to IP_TaskFindName.
A pointer to a character buffer to hold the return from the call.
The length of retbuf, in bytes.
One of the following:
Writes a line when data from any point is eligible to be written. Leaves values for all other points empty.
Writes a line when data from any point is eligible to be written. Writes previous values for all other points.
Writes a line only after data from all points is eligible to be written.
The number of labels (log or group names) referenced in the labels argument.
An array of char*, each of which is a pointer to a string containing a log or group name.
ST_OK on success. Otherwise ST_ERROR, and the retbuf will contain a more detailed error message (see collect in the Cascade TextLogger documentation). If the return value is ST_OK, the retbuf may not contain useful information.
This function lets you specify when a line of data in a given log or group is considered complete, and ready for writing. If no labels are 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.
The Cascade TextLogger always keeps one line of output for each log in a buffer. Whenever a point changes value, the TextLogger checks each log to see if it includes that point. If so, the TextLogger checks the style specified for the log. If it is any or fill and if the tolerance for that log has been exceeded, the line in the buffer gets written immediately, and this point is entered in a new line in the buffer. But if the style is set to all, the TextLogger keeps the line in the buffer until every point in the log has changed at least once, or until a point is logged beyond the tolerance. When one of these conditions is met, the line gets written.
This function corresponds to the Cascade TextLogger collect command.
| |  | |
| LG_Cache |  | LG_Disable |
Copyright © 1995-2010 by Cogent Real-Time Systems, Inc. All rights reserved.