Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiSetFilterOptions

hiSetFilterOptions(
g_accelInput
g_prompt
g_output
g_returnAccel
g_typedReturn
g_errorOutput
g_warnOutput
) 
=> t / nil 

Description

Sets the output message filter for the CIW with the specified options. This function corresponds to the Set Log File Display Filter form (displayed by choosing Options – Log Filter in the CIW). Standard message output, return values from typed-in commands, errors and warning messages are displayed by default.

Arguments

g_accelInput

Displays accelerated input (menu and bindkey commands, form and field value settings and callbacks, etc.). Log file prefix: \a

The default is nil.

g_prompt

Displays prompt output. Log file prefix: \p

The default is nil.

g_output

Displays standard message output. Log file prefix: \o

The default is t.

g_returnAccel

Displays return values from accelerated input. Log file prefix: \r

The default is nil.

g_typedReturn

Displays return values from typed-in commands. Log file prefix: \t

The default is t.

g_errorOutput

Displays error message output. Log file prefix: \e

The default is t.

g_warnOutput

Displays warning message output. Log file prefix: \w

The default is t.

The defaults listed are the values in effect at start-up.

Values Returned

t

The output message filter is set.

nil

The output message filter is not set. An error message is also displayed.

Related Topics

Log File Functions


Return to top
 ⠀
X