Product Documentation
Cadence Application Infrastructure SKILL Reference
Product Version IC23.1, November 2023

lmgrDisplayMessage

lmgrDisplayMessage( 
t_text 
[ g_logOnly ]
) 
=> t / nil 

Description

Displays a string in the Message area on the Library Manager form and appends it to the Library Manager log file. If desired, the message can be written just to the Library Manager log file and not echoed to the user. Ensure that the string is terminated by a newline character, or the string might be confused with the output from other Library Manager commands or other calls to this function.

Arguments

t_text

The string to output in the Library Manager log file.

g_logOnly

Delivers the string to the message window and writes it to the log file if the string is not specified or is specified as nil, and writes the string just to the log file otherwise.

Value Returned

t

The string is successfully transmitted to the Library Manager.

nil

Either no Library Manager process is running or an error occurred in transmitting the string.

Examples

This example writes a short message to the log file.

lmgrDisplayMessage( "Virtuoso talking to libManager" ) 
=> t

Related Topics

lmgrVerbose


Return to top
 ⠀
X