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

lmgrGetObject

lmgrGetObject( 
t_objName
) 
=> l_attrList / nil 

Description

Returns a list describing the state of the single named object or nil if the object does not exist. The format of the attribute list will be variable length list of tags (strings) paired with matching values that are either a string or Boolean value.

This SKILL API can be used in Virtuoso and cdsLibMgr.il.

Arguments

t_objName

Name of a menu or menu item.

Value Returned

l_attrList

An associated list of tags (strings) paired with values to reflect the status of the named object.

The example below shows how this associated list appears. The possible tags are parent, type, managed, sensitive, state, label, mnemonic, and font.

The state value can be nil for objects that have no state, such as for separators or simple buttons. The state uses nil for off/false, and t for on/true. This also applies to the Boolean managed and sensitive values.

The sensitive value returned is the logical AND combination of the current value for the object and the values of the menus. For example, menu M contains menu item I. M is not sensitive, but I is sensitive, so the sensitive value returned for I would be nil.

nil

The named object does not exist.

Examples

Retrieves the settings of the View – Filters menu item.

lmgrGetObject( "viewFilterButton" ) => 
(( "parent" "viewCascade" )    ( "type" "simple" )
( "managed" t )
( "sensitive" t )
( "label" "Filters... " )
( "font" nil )
( "mnemonic" nil )
)

Related Topics

lmgrSetObject


Return to top
 ⠀
X