•  

AddParameter Method (ExternalDefinition, BuiltInParameterGroup, Boolean)

Add a new shared parameter to the family.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)

Syntax

C#
[ObsoleteAttribute("This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `AddParameter(ExternalDefinition, ForgeTypeId, bool)` method instead.")]
public FamilyParameter AddParameter(
	ExternalDefinition familyDefinition,
	BuiltInParameterGroup parameterGroup,
	bool isInstance
)
Visual Basic
<ObsoleteAttribute("This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `AddParameter(ExternalDefinition, ForgeTypeId, bool)` method instead.")> _
Public Function AddParameter ( _
	familyDefinition As ExternalDefinition, _
	parameterGroup As BuiltInParameterGroup, _
	isInstance As Boolean _
) As FamilyParameter
Visual C++
[ObsoleteAttribute(L"This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `AddParameter(ExternalDefinition, ForgeTypeId, bool)` method instead.")]
public:
FamilyParameter^ AddParameter(
	ExternalDefinition^ familyDefinition, 
	BuiltInParameterGroup parameterGroup, 
	bool isInstance
)

Parameters

familyDefinition
Type: Autodesk.Revit.DBExternalDefinition
The definition of the loaded shared parameter.
parameterGroup
Type: Autodesk.Revit.DBBuiltInParameterGroup
The group to which the family parameter belongs.
isInstance
Type: SystemBoolean
Indicates if the new parameter is instance or type.

Return Value

If creation was successful the new shared parameter is returned, otherwise an exception with failure information will be thrown.

Remarks

This method can work even without any family type, but it cannot be assigned the value via FamilyManager.Set methods when there is no current type.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException Thrown when the input parameter group cannot be assigned to the new parameter.
Autodesk.Revit.ExceptionsInvalidOperationException Thrown when the shared family parameter creation is not supported. Or trying to add an instance parameter of image type.

See Also