gpeCreateDummyConfigParam

gpeCreateDummyConfigParam(
t_name
[ ?type t_type ]
[ ?value t_value ]
[ ?verbose { t | nil } ]
) 
=> l_dummyConfigParam / nil

Description

Creates a dummyConfigParam DPL that can be added to a list with other dummyConfigParam DPLs and passed as the parameters argument to gpeCreateDummyConfig to create a dummyConfig DPL.

Arguments

t_name	Specifies the name of a cdfParameter or the name of the parameter placeholder that is mapped by ciMapParam.
?type t_type	Controls how the parameter can be set. Valid values are: default: Uses the default cdfParameter value, which is the minimum. specify: Lets you specify a value. match_src: Copies the parameter from the dummy source.
?value t_value
	Specifies the value to be applied to the cdfParameter when ?type is set to specify.
?verbose { t | nil }	Controls the display of warning messages.

Value Returned

l_dummyConfigParam	Returns the dummyConfigParam DPL created. Example: (nil name "l" type "specify" value "45n")
nil	Could not create the dummyConfigParam DPL.

Example

Creates a dummyConfigParam DPL with the specified name. The ?type is set to specify and the value is set to 45n:

dummyConfigParam = gpeCreateDummyConfigParam("I" ?type "specify" ?value "45n")

=> (nil value "45n" type "specify" name "I")

In the following example, ?type is set to default:

dummyConfigParam = gpeCreateDummyConfigParam("I" ?type "default")

=> (nil value "" type "default" name "I")

Return to top