Console Output and Logging

The commands in this section relate to textual output to the console and to the operation of the log file. The commands covered in this section are as follows:

Error messages

ixErrorInfo

Refer to “ixErrorInfo” for a full description of this global variable. The $::ixErrorInfo global variable holds the text associated with the error return from most TCL API commands. For example:

ixPuts $::ixErrorInfo

setIxErrorInfo

This command expects a string as parameter (msg) and does not return anything. The string (msg) is set as the value of ixErrorInfo.

errorMsg

The errorMsg command outputs its arguments to the error file with or without a newline. The format of the command is as follows:

errorMsg [-nonewline] arg...

where -nonewline indicates that a newline should not be appended to the output and arg... is any number of arguments, which is concatenated and logged.

Refer to “errorMsg” for a full description of this command.

Console Output

ixPuts

Refer to “ixPuts” for a full description of this command. The ixPuts command outputs its arguments to the console window with or without a newline. The format of the command is as follows:

ixPuts [-nonewline] arg...

where -nonewline indicates that a newline should not be appended to the output and arg... is any number of arguments, which is concatenated and printed.

Logging

logOn / logOff

These commands enable and disable logging. The logOn command also defines the name of the log file. The format of these commands are as follows:

logOn filename

logOff

where filename is the name of the log file to be created.

Refer to “logOn” and “logOff” for a full description of these commands.

logMsg

The logMsg command outputs its arguments to the log file with or without a newline. The format of the command is as follows:

logMsg [-nonewline] arg...

where -nonewline indicates that a newline should not be appended to the output and arg... is any number of arguments, which is concatenated and logged.

Refer to “logMsg" for a full description of this command.

enableEvents

This command enables or disables the creation of a separate log file to hold errors and warnings produced by API calls. The log file created includes the time and date of creation and is held in C:\Program Files\Ixia. This feature is enabled by default on Windows-based machines and disabled by default on Unix-based machines.

Refer to “enableEvents” for a full description of this command.