LAnnContainer::Insert

#include "ltwrappr.h"

virtual L_INT LAnnContainer::Insert(LAnnObject, bStripContainer=FALSE)

LAnnotation& LAnnObject;

the annotation object to insert

L_BOOL bStripContainer;

flag that indicates whether to insert a container

Inserts the specified annotation object into the Container.

Parameter Description
LAnnObject The annotation object to insert.
bStripContainer Flag that indicates whether to insert a container. Possible values are:
  Value Meaning
  TRUE If the LAnnObject parameter specifies a container, only the objects in the container will be inserted into the new container. In this case, the container specified in LAnnObject is destroyed.
  FALSE If the LAnnObject parameter specifies a container, the container and all objects within the container (objects and other containers ) will be inserted into the new container.
    If the LAnnObject parameter specifies an object, that object will be inserted into the new container.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If LAnnObject is a single annotation object, set bStripContainer to FALSE. That way the object itself is inserted.

If LAnnObject is a container, setting bStripContainer to TRUE will insert only the objects within the container, not the container itself.

If LAnnObject is a container, setting bStripContainer to FALSE will insert the container and all objects within the container.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C++ Class Library Help