cdfRegRemasterTrigger

cdfRegRemasterTrigger(
t_triggerFunc
)
=> l_ids / nil

Description

Registers a trigger that is called after instance remastering to set, map, or clear the parameter values on the remastered instance. The registered trigger function is only called when the resetOnRemaster environment variable is set to t.

It is possible to register a trigger before defining the function. No capturing of the function is performed and only the most up-to-date implementation is called. Only one trigger can be registered and any existing registration is replaced.

Arguments

t_triggerFunc

The name of the user-specified remastering function. The function must be defined in the following format: (d_instId d_newMasterCVID) => l_returnDPL Here, d_instId is the database instance ID being remastered d_newMasterCVID is the ID of the new master l_returnDPL is a DPL created by the cdfRemasterAction function The cdfRemasterAction SKILL function is used to build the return DPL.

Value Returned

t	The user-specified trigger was registered.
nil	The argument cannot be converted to a string.

Examples

Defines a remaster function. The callback MyRemasterFunc specifies:

1. The formInitProc of the new master is not called.
2. The formDoneProc of the new master is called.
3. The property p1 is set to the value 1 and the property values p2 and p3 are set to the instance value before remastering.

(defun MyRemasterFunc (instId newMasterCvId) cdfRemasterAction(?noFormInitCall t ?noFormDoneCall nil ?paramList list(list("p1" 1) "p2" "p3")))

Registers the remaster function.

cdfRegRemasterTrigger("MyRemasterFunc")
=>t

Performs the remastering on an instance.

dbRemasterAnyInst(inst new_cv)
=>t

Related Topics

cdfRemasterAction

cdfUnregRemasterTrigger

Return to top