This document is archived and information here might be outdated. Recommended version. |
Defines the properties of the linear unit.
[Visual Basic .NET]
Public Sub Define ( _
[ByRef Name As Object], _
[ByRef Alias As Object], _
[ByRef Abbreviation As Object], _
[ByRef Remarks As Object], _
[ByRef MetersPerUnit As Object] _
)
[C#]
public void Define (
ref object Name,
ref object Alias,
ref object Abbreviation,
ref object Remarks,
ref object MetersPerUnit
);
[C++]
HRESULT Define(
Variant* Name,
Variant* Alias,
Variant* Abbreviation,
Variant* Remarks,
Variant* MetersPerUnit
);
[C++] Parameters Name [optional]
Name is a parameter of type VARIANT* Alias [optional]
Alias is a parameter of type VARIANT* Abbreviation [optional]
Abbreviation is a parameter of type VARIANT* Remarks [optional]
Remarks is a parameter of type VARIANT* MetersPerUnit [optional]
MetersPerUnit is a parameter of type VARIANT*
The Define function allows you to define the properties of a linear unit of measure. Use the metersPerUnit parameter to define how many meters comprise one unit.
private ILinearUnit DefineLinearUnit()
{
//Query interface for LinearUnitEdit
ILinearUnitEdit linearUnitEdit = new LinearUnitClass();
//Define the properties for the linear unit
object name = "Meter";
object alias = "Meter";
object abbreviation = "M";
object remarks = "Meter is the linear unit";
object metersPerUnit = 1;
linearUnitEdit.Define(ref name, ref alias, ref abbreviation, ref remarks, ref metersPerUnit);
return linearUnitEdit as ILinearUnit;
}