Logging Functions

Overview

logging functions.

Function List

ohLogFile ()
ohLogLevel ()
ohLogSetConsole ()
ohLogSetFile ()
ohLogSetLevel ()
ohLogWriteMessage ()

Function Documentation

ohLogFile

string returnValue
 
ohLogFile(
        any Trigger)

Description:

get log file.

Supported Platforms:

Excel

Parameters

Trigger

dependency tracking trigger

ohLogLevel

long returnValue
 
ohLogLevel(
        any Trigger)

Description:

get log level.

Supported Platforms:

Excel

Parameters

Trigger

dependency tracking trigger

ohLogSetConsole

void returnValue
 
ohLogSetConsole(
        long Console
        long LogLevel
        any Trigger)

Description:

fork output to stdout.

Supported Platforms:

C++

Parameters

Console	1 (enable) / 0 (disable).
LogLevel	threshold for log messages. Default value = 4.
Trigger	dependency tracking trigger

ohLogSetFile

string returnValue
 
ohLogSetFile(
        string LogFileName
        long LogLevel
        any Trigger)

Description:

begin logging to named file.

Supported Platforms:

Excel, C++, Calc

Parameters

LogFileName	path and name of log file.
LogLevel	threshold for log messages. Default value = 4.
Trigger	dependency tracking trigger

ohLogSetLevel

void returnValue
 
ohLogSetLevel(
        long LogLevel
        any Trigger)

Description:

set threshold for log messages.

Supported Platforms:

Excel, Calc

Parameters

LogLevel	threshold for log messages.
Trigger	dependency tracking trigger

ohLogWriteMessage

void returnValue
 
ohLogWriteMessage(
        string LogMessage
        long LogLevel
        any Trigger)

Description:

log a message.

Supported Platforms:

Excel, C++

Parameters

LogMessage	message to be logged.
LogLevel	threshold for log messages. Default value = 4.
Trigger	dependency tracking trigger