ADDRESS VOX Commands › Notification Manager Database Maintenance Commands › DESTROYPARM Command

DESTROYPARM Command

The DESTROYPARM command destroys an existing parameter. However, you cannot destroy a method parameter if it has overrides at either the entity level or the time block level. You must first delete all parameter overrides.

This command has the following format:

ADDRESS VOX "DESTROYPARM KEY(key)
[CASCADE(YES|NO)]"

KEY

Specifies the key of the parameter to be deleted.

CASCADE

(Optional) Valid values are:

YES

Destroy all other items in the database that refer to this item.

NO

Do not destroy any other items in the database that refer to this item.

Default: NO

For example, if you specify CASCADE(YES) when deleting a parameter, all of the personal and time block-specific parameter overrides are deleted. If you specify CASCADE(NO) for a parameter that has personal and time block-specific parameter overrides, the command fails.

Return Information:

After DESTROYPARM executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero.
• If the command does not execute successfully, the RC variable contains a nonzero value. Additionally, the VOX.ERROR variable contains the complete VOX error message, which includes the four digit return code and error message text.

Usage Notes:

For more information about obtaining associated data, see the listparm.rex REXX program.

Example:

The following example removes the entry for the parameter with key 300001030 from the database:

ADDRESS VOX "DestroyParm KEY(300001030)"