M

Document.LoadFamilySymbol

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

Remarks:
This function supports loading of types/symbols stored in the family, or those available in the family Type Catalog file.

Overloads (3):

LoadFamilySymbol(String,String)

LoadFamilySymbol(String,String,FamilySymbol)

LoadFamilySymbol(String,String,IFamilyLoadOptions,FamilySymbol)

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
)

System.String

filename

The fully qualified filename of the Family file, usually ending in .rfa.
System.String

name

The name of the type/symbol to be loaded, such as "W11x14".
Autodesk.Revit.DB.IFamilyLoadOptions

familyLoadOptions

The interface implementation to use when loading a family into the document.
Autodesk.Revit.DB.FamilySymbol%

symbol

A reference to the family symbol that was loaded if successful, otherwise Nothing.

Return Value bool True if the family type/symbol was loaded successfully into the project, otherwise False.

Autodesk.Revit.Exceptions.ArgumentException

Thrown when filename or name isnullNothingnullptra null reference (Nothingin Visual Basic)or empty.