This document is archived and information here might be outdated.  Recommended version.


ILinearUnitEdit.Define Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Geometry)  

ILinearUnitEdit.Define Method

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#]

Optional Values

Name   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Alias   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Abbreviation   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
Remarks   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
MetersPerUnit   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
[C++]
HRESULT Define(
  VARIANT* Name,
  VARIANT* Alias,
  VARIANT* Abbreviation,
  VARIANT* Remarks,
  VARIANT* MetersPerUnit
);
[C++]

Parameters Name [optional] Name is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Alias [optional] Alias is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Abbreviation [optional] Abbreviation is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. Remarks [optional] Remarks is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. MetersPerUnit [optional] MetersPerUnit is a parameter of type VARIANT
To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

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.

[C#]

    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;
    }

See Also

ILinearUnitEdit Interface