[<<Previous Entry]
[^^Up^^]
[Next Entry>>]
[Menu]
[About The Guide]
USTAMP
. Summary
ustamp(str <text>, int <new_entry>, int <add_nl>);
. Description
The ustamp function is used to place (stamp) text into the Telix us-
age log. If the usage log is currently not open, this function call
is simply ignored. <text> is the entry that should be placed into
the usage log. If <new_entry> contains a non-zero (TRUE) value, the
current date/time is placed ahead of the text, otherwise it is as-
sumed that this is a continuation of a previous entry and no
date/time is added. If <add_nl> (add new line) is a non-zero (TRUE)
value, a Carriage Return and Line Feed character are added after the
entry. This is usually the case unless something else must be added
on the same line.
. Return Value
A value of -1 is returned if there is a problem writing to the usage
log, otherwise a non-zero (TRUE) value is returned.
. Example
ustamp("Calling user subroutine... ", 1, 0);
if (user_sub == -1)
ustamp("Failed!, 0, 1);
else
ustamp("Successful", 0, 1);
See Also:
usagelog
usage_stat
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson