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

gpeSboxp

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

Description

Checks whether the specified object is a valid Modgen sandbox object.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

The specified object is a valid Modgen sandbox object.

nil

The specified object is not a valid Modgen sandbox object.

Example

Creates a Modgen sandbox object and assigns it to sb. The gpeSboxp function is then used to determine if this Modgen sandbox object is valid. Return value t indicates that sb is a valid Modgen sandbox object:

sb = gpeCreateSandbox() 
=> pe:0x#####
gpeSboxp(sb) 
=> t

The value of sb is set to nil. The gpeSboxp function is then used to determine if this Modgen sandbox object is valid. Return value nil indicates that sb is not a valid Modgen sandbox object:

sb = nil
gpeSboxp(sb) 
=> nil

Return to top
 ⠀
X