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

gpeGetGridColCount

gpeGetGridColCount(
u_sandbox
[ ?verbose { t | nil } ]
)
=> x_columnCount / nil

Description

Returns the number of columns available in the grid of the given Modgen sandbox object.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

x_columnCount

Number of columns in the grid of the given Modgen sandbox object.

nil

The command was unsuccessful.

Example

In the following example, a Modgen sandbox object is instantiated. gpeGetGridColCount is then used to retrieve the number of columns:

sbox = gpeStartSandbox()  => pe:0x####
gpeGetGridColCount(sbox)  => 3

Return to top
 ⠀
X