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

hiSetTreeItemDescription

hiSetTreeItemDescription(
g_item
g_description
)
=> t / nil

Description

Changes the item description. The description is initially set with the g_description argument of hiCreateTreeItem. To get the current description, use hiGetTreeItemDescription.

Arguments

g_item

The item whose description you want to change. This is the return value of hiCreateTreeItem.

g_description

The new description for the argument, specified as a list of strings or symbols.

Values Returned

t

The new description was set for the item.

nil

The new description could not be set for the item.

Related Topics

Form and Field Functions

hiGetTreeItemDescription

hiCreateTreeItem

hiGetTreeItems

hiCreateTreeTable


Return to top
 ⠀
X