M

FamilyManager.ReplaceParameter

Description:
Replace a shared family parameter with a new non-shared family parameter.

Overloads (2):

ReplaceParameter

ReplaceParameter(FamilyParameter,ExternalDefinition,ForgeTypeId,Boolean)

ReplaceParameter(FamilyParameter,String,ForgeTypeId,Boolean)

public FamilyParameter ReplaceParameter(
	FamilyParameter currentParameter,
	string parameterName,
	ForgeTypeId groupTypeId,
	bool isInstance
)

Public Function ReplaceParameter ( 
	currentParameter As FamilyParameter,
	parameterName As String,
	groupTypeId As ForgeTypeId,
	isInstance As Boolean
) As FamilyParameter

public:
FamilyParameter^ ReplaceParameter(
	FamilyParameter^ currentParameter, 
	String^ parameterName, 
	ForgeTypeId^ groupTypeId, 
	bool isInstance
)

member ReplaceParameter : 
        currentParameter : FamilyParameter * 
        parameterName : string * 
        groupTypeId : ForgeTypeId * 
        isInstance : bool -> FamilyParameter

FamilyParameter

currentParameter

The current family parameter.
String

parameterName

The name of the new family parameter.
ForgeTypeId

groupTypeId

The identifier of the group to which the new family parameter belongs.
Boolean

isInstance

Indicates if the new parameter is instance or type.

Return Value FamilyParameter If replacement was successful the new family parameter is returned, otherwise an exception with failure information will be thrown.

ArgumentNullException

Thrown when the input argument-"currentParameter" or "parameterName"-is.
ArgumentException

Thrown when the input argument-"currentParameter"-is invalid, or the input parameter group cannot be assigned to the new parameter, or the input name string contains illegal characters, or duplicated with existing parameter name.
InvalidOperationException

Thrown when trying to replace a built-in parameter or family parameter.
InvalidOperationException

Thrown when replacement failed, because the replacement would cause a formula error. Or trying to replace with an instance parameter of image type.