ALTERPARM Command

The ALTERPARM command changes the characteristics of a parameter.

This command has the following format:

ADDRESS VOX "ALTERPARM KEY(parm key)
  [DESC(desc)]
  [VALUE(value)]"

KEY: Specifies the key of the parameter whose characteristics are to be altered.
DESC: (Optional) Describes the usage and meaning of this parameter. This data is not passed to the methods. This keyword may only be specified when the parameter is a method level parameter. The maximum length of this operand is 1000 characters.
VALUE: (Optional) Specifies the actual value of this parameter for the specified method and item. This data is passed to the methods. The maximum length of this operand is 240 characters.

Return Information:

After ALTERPARM 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.

Example:

The following example changes the value for parameter 300001039 to 68:

ADDRESS VOX "AlterParm KEY(300001039) VALUE(68)"