Revit 2023 API |
LightFamily..::..GetLightTypeName Method |
LightFamily Class See Also |
Return the name for the light type at the given index
Namespace: Autodesk.Revit.DB.Lighting
Assembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since:
2013
Syntax
C# |
---|
public string GetLightTypeName( int index ) |
Visual Basic |
---|
Public Function GetLightTypeName ( _ index As Integer _ ) As String |
Visual C++ |
---|
public: String^ GetLightTypeName( int index ) |
Parameters
- index
- Type: System..::..Int32
The index of the light type
Return Value
The name of the light type at the given index
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | The index is the argument that is being validated The index is not valid because it does not correspond to a valid light type |