| Revit 2024 API |
| UnitUtils..::..ConvertToInternalUnits Method |
| UnitUtils Class See Also |
Converts a value from a given unit to Revit's internal units.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:
2014
Syntax
| C# |
|---|
public static double ConvertToInternalUnits( double value, ForgeTypeId unitTypeId ) |
| Visual Basic |
|---|
Public Shared Function ConvertToInternalUnits ( _ value As Double, _ unitTypeId As ForgeTypeId _ ) As Double |
| Visual C++ |
|---|
public: static double ConvertToInternalUnits( double value, ForgeTypeId^ unitTypeId ) |
Parameters
- value
- Type: System..::..Double
The value to convert.
- unitTypeId
- Type: Autodesk.Revit.DB..::..ForgeTypeId
Identifier of the unit quantifying the value.
Return Value
The converted value.
Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.Exceptions..::..ArgumentException | The given value for value is not finite -or- unitTypeId is not a unit identifier. See UnitUtils.IsUnit(ForgeTypeId) and UnitUtils.GetUnitTypeId(DisplayUnitType). |
| Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was null |