get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconic (Operator)

Name

get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconic — Return the iconic object of a drawing object.

Signature

get_drawing_object_iconic( : Object : DrawID : )

Description

get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconic returns the iconic object ObjectObjectObjectObjectobjectVal that corresponds to the drawing object DrawIDDrawIDDrawIDDrawIDdrawID. In addition, the parameters that define the drawing object can be queried with the operator get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

ObjectObjectObjectObjectobjectVal (output_object) object(-array) → object

Copy of the iconic object represented by the drawing object.

DrawIDDrawIDDrawIDDrawIDdrawID (input_control) drawing_object → (integer)

Handle of the drawing object.

Result

clear_drawing_objectclear_drawing_objectClearDrawingObjectClearDrawingObjectClearDrawingObject returns 2 (H_MSG_TRUE), if the DrawIDDrawIDDrawIDDrawIDdrawID is valid. Otherwise an exception is raised.

Possible Predecessors

create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse, create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCircleCreateDrawingObjectCircle, create_drawing_object_linecreate_drawing_object_lineCreateDrawingObjectLineCreateDrawingObjectLineCreateDrawingObjectLine, create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSector, create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSector, create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldCreateDrawingObjectXld

Possible Successors

reduce_domainreduce_domainReduceDomainReduceDomainReduceDomain, gen_region_contour_xldgen_region_contour_xldGenRegionContourXldGenRegionContourXldGenRegionContourXld, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

Alternatives

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams

See also

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

Module

Foundation