Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

gpeGetFigGroup

gpeGetFigGroup(
u_sandbox
[ ?verbose { t | nil } ]
)
=> d_figGoupID / nil

Description

Returns the ID of the Modgen figGroup that is associated with the specified Modgen sandbox object.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

d_figGroupID

Returns the figGroup ID of the Modgen associated with the specified Modgen sandbox object.

nil

Could not find a matching Modgen figGroup.

Example

In the following example, the value for sb is determined by calling gpeEditSandbox. This value is then passed as argument for gpeGetFigGroup:

sb = gpeEditSandbox()
fg = gpeGetFigGroup(sb)

Return to top
 ⠀
X