Cadcorp SIS API Methods

GetPos

Description

Get a position from the user. The return type is dependent on the choice of method. GetPos returns whether a position has been snapped. GetPosEx will return the command argument (i.e. Snap, KeyBack, KeyEnter, End).

Both methods allow the use of Snapcodes for positional input.

Snapped selectable items are stored in the Named List “*snapped”.

GetPos and GetPosEx will store either Cartesian or Spherical Coordinates depending on the map window Coordinate Reference System.

Syntax

Visual Basic
Public Function GetPos( _ ByVal x As Double, _ ByVal y As Double, _ ByVal z As Double _ ) As Boolean

Parameters

x: The x coordinate of the snapped position
y: The y coordinate of the snapped position
z: The z coordinate of the snapped position

Return Type

`True (-1)`	the user snapped a position
`False (0)`	the user pressed the Escape key, or another command was selected

If the return value is True, any snapped item will be placed in a special Named List "*snapped".

Remarks

Available: MD ME MM PySIS

Group:

Coordinate Methods

Example

sis.GetPos (x, y, z)

Send comments on this topic.

Click to return to www.cadcorp.com