FamilyManager.RenameParameter
Method
Description:
Rename a family parameter.
Rename a family parameter.
Remarks:
This operation is valid only for Family Parameters, and is invalid for Shared Parameters and Built-in Parameters.
This operation is valid only for Family Parameters, and is invalid for Shared Parameters and Built-in Parameters.
Parameters
Parameter | Type | Description |
---|---|---|
familyParameter | FamilyParameter | The family parameter. |
name | String | The new name. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | Thrown when the input argument-"familyParameter" or "name"-is. |
ArgumentException | Thrown when the input argument-"familyParameter"-is invalid, or the input name string contains illegal characters, or duplicated with existing parameter name. |
InvalidOperationException | Thrown when trying to rename a built-in parameter or shared parameter. |