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

hiGetWindowName

hiGetWindowName(
w_windowId 
) 
=> t_windowName / nil 

Description

Returns the window name, which is displayed in the window manager frame of a window. This name is set with the hiSetWindowName function.

A session window displays the window name of the window that is currently active within it, unless it is not set, in which case it displays the session window name. This function, however, always returns the session window name when passed a session window.

This function is not available in Concept SKILL. For more information, see Design Entry HDL–SKILL Routines.

Argument

w_windowId

The ID of the window, session window, or dockable window whose name you want to get.

Value Returned

t_windowName

The window name.

nil

The window is invalid or the window does not have a name associated with it (such as a plot window).

Related Topics

Window Functions

hiSetWindowName


Return to top
 ⠀
X