All Cadcorp SIS API Methods

GetPosEx

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

SIS_ARG_BACKSPACE (2)  the user pressed the Backspace key
SIS_ARG_ENTER (1) the user pressed the Escape key, or another command was selected
SIS_ARG_POSITION (3) the user snapped a position

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

Remarks

Available: D PySIS

Group:

Example

sis.GetPosEx (x, y, z)