Document.LoadFamilySymbol(String, String, IFamilyLoadOptions, FamilySymbol) Method

DocumentLoadFamilySymbol(String, String, IFamilyLoadOptions, FamilySymbol) Method

Loads only the specified family type/symbol from a family file into the document and provides a reference to the loaded family symbol.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public bool LoadFamilySymbol(
	string filename,
	string name,
	IFamilyLoadOptions familyLoadOptions,
	out FamilySymbol symbol
)
Public Function LoadFamilySymbol ( 
	filename As String,
	name As String,
	familyLoadOptions As IFamilyLoadOptions,
	<OutAttribute> ByRef symbol As FamilySymbol
) As Boolean
public:
bool LoadFamilySymbol(
	String^ filename, 
	String^ name, 
	IFamilyLoadOptions^ familyLoadOptions, 
	[OutAttribute] FamilySymbol^% symbol
)
member LoadFamilySymbol : 
        filename : string * 
        name : string * 
        familyLoadOptions : IFamilyLoadOptions * 
        symbol : FamilySymbol byref -> bool

Parameters

filename  String
The fully qualified filename of the Family file, usually ending in .rfa.
name  String
The name of the type/symbol to be loaded, such as "W11x14".
familyLoadOptions  IFamilyLoadOptions
The interface implementation to use when loading a family into the document.
symbol  FamilySymbol
A reference to the family symbol that was loaded if successful, otherwise Nothing.

Return Value

Boolean
True if the family type/symbol was loaded successfully into the project, otherwise False.
Exceptions
ExceptionCondition
ArgumentException Thrown when filename or name is or empty.
Remarks
This function supports loading of types/symbols stored in the family, or those available in the family Type Catalog file.
See Also

M:Autodesk.Revit.DB.Document.LoadFamilySymbol(System.String,System.String,Autodesk.Revit.DB.IFamilyLoadOptions,Autodesk.Revit.DB.FamilySymbol@)