All Cadcorp SIS API Methods

StrFromMetre Method

Description

Formats a metre dimension as a string, in a chosen format.

Syntax

Visual Basic 
Public Function StrFromMetre( _
   ByVal metre As Double, _
   ByVal nDim As Integer, _
   ByVal bShowUnits As Integer _
) As String

Parameters

metre
The metre dimension to be formatted.
 
nDim

SIS_LENGTHDIM    Format the dimension as a length.
SIS_AREADIM    Format the dimension as an area.
SIS_VOLUMEDIM    Format the dimension as a volume.
 
bShowUnits

True    Show the units in the formatted string.
False    Do not show the units in the formatted string.

Return Type

A string formatted in the current units.

Remarks

Available: D OD OM OV

Group:

Example

rv = sis.StrFromMetre (1000, SIS_LENGTHDIM,TRUE)