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

mptDefineFlow

mptDefineFlow(
t_flowName
s_setFunction
[ s_checkFunction ]
)
=> t / nil

Description

Registers a flow by linking the flow name to a set and a check procedure. If the check procedure is not defined, the check defined in the cdsenv file is run. This function checks the environment variables defined in the set function against their current values.

The s_setFunction and s_checkFunction procedures should be defined in the current virtuoso session before the mptDefineFlow calls these procedures.

Arguments

t_flowName

Name of the flow to be defined.

s_setFunction

Name of the procedure used to apply the flow settings.

s_checkFunction

Name of the procedure used to check the flow settings. This is an optional argument.

Values Returned

t

The flow is defined.

nil

The flow is not defined.

Example

load "mptCustomFlow.il"
mptDefineFlow( "custom" 'TacticalFlow_from_CDN_SETUP 'TacticalFlow_from_CDN_CHECK)

Return to top
 ⠀
X