cdfDeleteParam

cdfDeleteParam(
g_cdfParamId
) 
=> t / nil

Description

Deletes the specified CDF parameter.

If the CDF parameter is attached to a base-level CDF description, you must have the write permissions for the object to which the CDF description is attached.

CDF checks that no invalid parameter descriptions would result from deleting the specified parameter before it is deleted. This would occur if you tried to delete a base-level parameter and a user-level parameter is defined that only partially overrides the base-level description.

Arguments

g_cdfParamId

Specifies the ID of the CDF parameter to be deleted.

Value Returned

t	Deletes the specified CDF parameter.
nil	Returns nil if: Invalid parameter descriptions would result from deleting the specified parameter You do not have the write permissions for the object to which the CDF description is attached

Return to top