GlobalParametersManager.FindByName Method

GlobalParametersManagerFindByName Method

Finds whether a global parameter with the given name exists in the input document.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public static ElementId FindByName(
	Document document,
	string name
)
Public Shared Function FindByName ( 
	document As Document,
	name As String
) As ElementId
public:
static ElementId^ FindByName(
	Document^ document, 
	String^ name
)
static member FindByName : 
        document : Document * 
        name : string -> ElementId

Parameters

document  Document
The document expected to contain the global parameter.
name  String
Name of the global parameter

Return Value

ElementId
ElementId of the parameter element, or InvalidElementId if it was not found.
Exceptions
ExceptionCondition
ArgumentNullException A non-optional argument was null
Remarks
No exception is thrown when no parameter with such a name exists in the document; instead, the method returns an ElementId.InvalidElementId.
See Also

M:Autodesk.Revit.DB.GlobalParametersManager.FindByName(Autodesk.Revit.DB.Document,System.String)