C++ Syntax

__int32

MKI_InputGetIdentObject(

__int32 f_nPointIndex,

MKI_GEO_OBJECT_REF f_rGeoObject );

Retrieves a standard object resulting from object-dependent identification.

Parameters

PointIndex

[__int32] Zero-based point index. This index states during which point's entry the identification was done. If, e.g., PointIndex is 1, the application will search for the object identified by entering the point with index 1, i.e. the second point. Valid range: 0 <= Value < MKI_INPUT_MAX.

GeoObject

[MKI_GEO_OBJECT_REF] Address of a buffer to receive the retrieved identified object. Point handles and outline indexes will be set as far as possible.

Return Value

Returns the retrieved object's type or -1 if no valid object is found. Only for the following object types, GeoObject will be initialized:

MKI_OBJ_LINE

Straight line.

MKI_OBJ_CIRCLE

Circle.

MKI_OBJ_ARC

Circular arc.

MKI_OBJ_SECTOR

Circular sector.

MKI_OBJ_SEGMENT

Circular segment.

MKI_OBJ_ELLIPSE

Ellipse.

MKI_OBJ_EARC

Elliptical arc.

MKI_OBJ_ESECTOR

Elliptical sector.

MKI_OBJ_ESEGMENT

Elliptical segment.

MKI_OBJ_GEOLINE

Construction Aid line (optionally printed object).

MKI_OBJ_GEOENDLESS

Construction Aid endless line (optionally printed object).

MKI_OBJ_GEOBEAM New in Version 2019.1

Construction Aid beam (optionally printed object).

MKI_OBJ_GEOCIRCLE

Construction Aid circle (optionally printed object).

MKI_OBJ_ARC

Construction Aid circular arc (optionally printed object).

MKI_OBJ_SECTOR

Construction Aid circular sector (optionally printed object).

MKI_OBJ_SEGMENT

Construction Aid circular segment (optionally printed object).

MKI_OBJ_GEOELLIPSE

Construction Aid ellipse (optionally printed object).

MKI_OBJ_EARC

Construction Aid elliptical arc (optionally printed object).

MKI_OBJ_ESECTOR

Construction Aid elliptical sector (optionally printed object).

MKI_OBJ_ESEGMENT

Construction Aid elliptical segment (optionally printed object).

Comment

This procedure will only intialize GeoObject if the identified object itself has one of the types listed as possible return values. In these cases, retrieving the identified object in form of a MKI_GEO_OBJECT is usually easier than retrieving the object's address and enumerating it.

Object-dependent identification is forced by using point types whose names begin with MKI_POINT_ID_ (but not with MKI_POINT_ID_MULTI). For a complete list of point types, see MKI_POINT_*.