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

gpeUnregisterPresetGen

gpeUnregisterPresetGen(
t_functionName
)
=> t / nil

Description

Unregisters the given preset generator function from the Grid Pattern Editor.

Arguments

t_functionName

Name of the preset generator function to be unregistered.

Value Returned

t

The preset generator function was unregistered.

nil

The preset generator function could not be unregistered.

Example

The following procedure first defines the preset generator function. Custom checks are performed to determine when the preset function has to be displayed. Then the function is registered and tested. Next, the function is unregistered and tested.

procedure(test_preset(sbox @optional selection) print("Hello world"))
=> test_preset
gpeUnregisterPresetGen("test_preset")
=> t if registered; nil if not registered
gpeRegisterPresetGen("gen1" "test_preset" "")
=> t
gpeIsRegisteredPresetGen("test_preset")
=>t
gpeUnregisterPresetGen("test_preset")
=> t
gpeIsRegisteredPresetGen("test_preset") 
=> nil


Return to top
 ⠀
X