hiPrintToLogFile

hiPrintToLogFile(
t_string
[ g_comment ]
)
=> t

Description

Prints the specified string to the CDS.log file and to any secondary log files that might have been opened with hiStartLog, without displaying it in the CIW output area.

Arguments

t_string	The string to be printed to the log file, it is preceded with the prefix \o in the log file.
g_comment	When the value of this argument is not nil, a comment line with the prefix \# is added to the log file. It is not displayed in the program output line.

Value Returned

t	Prints the specified string to the CDS.log file.

Examples

hiPrintToLogFile("This is an output line.")
t

The following is printed to the log file:

This is an output line.

hiPrintToLogFile("Can also print multiple output lines\nwith one statement.") t The following is printed to the log file:
Can also print multiple output lines
with one statement.


hiPrintToLogFile("This is a comment line." t)
t

The following is printed to the log file:

# This is a comment line.

hiPrintToLogFile("Can also print multiple comment lines\nwith one statement." t)
t

The following is printed to the log file:

# Can also print multiple comment lines
# with one statement.

Related Topics

Log File Functions

hiStartLog

hiEndLog

hiGetLogFileName

hiLogDragEvents

hiSetFilter

hiSetFilterOptions

Return to top