vreIsOption

vreIsOption(
g_vreHandle
s_optionName
)
=> t / nil

Description

Indicates whether a named option is valid for the specified vreHandle before calling vreGetOption or vreSetOption. Directly manipulating an option value that is not valid for the specified vreHandle using vreGetOption or vreSetOption results in a warning message.

Arguments

g_vreHandle	Routing environment handle object that is to be queried.
s_optionName	Symbol for the option whose validity is being tested with respect to the specified handle.

Value Returned

t	The specified option is valid for this handle and can be retrieved using vreGetOption and set using vreSetOption.
nil	The specified option is invalid for this handle. Attempting to retrieve this using vreGetOption or set it using vreSetOption results in a warning.

Examples

Indicates whether some options are valid for a given vreHandle.

handle = (vreGetHandle (geGetEditCellView) 'device 'gbr)

vreIsOption (handle 'route_nets)

=> t

vreIsOption (handle 'notAnOption)

=> nil

Related Topics

Virtuoso Automated Placement and Routing SKILL Functions

vreGetOption

vreGetHandle

vreSetOption

Return to top