L_AnnInsert

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnInsert(hContainer, hObject, fStripContainer)

HANNOBJECT hContainer;

/* handle to the container object */

HANNOBJECT hObject;

/* handle to the annotation object to insert */

L_BOOL fStripContainer;

/* flag that indicates whether to insert a container */

Inserts the specified annotation object into the specified container.

Parameter

Description

hContainer

Handle to the container object, a specialized annotation object.

hObject

Handle to the annotation object to insert.

fStripContainer

Flag that indicates whether to insert a container. Possible values are:

 

Value

Meaning

 

TRUE

If the hObject parameter specifies a container, only the objects in the container will be inserted into the new container. In this case, the container specified in hObject is destroyed.

 

FALSE

If the hObject 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 hObject 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 hObject is a single annotation object, set fStripContainer to FALSE. That way the object itself is inserted.

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

If hObject is a container, setting fStripContainer 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.

See Also

Functions:

L_AnnCreate, L_AnnRemove, L_AnnGetContainer, L_AnnGetTopContainer, L_AnnEnumerate, L_AnnGetItem, L_AnnAddUserHandle, L_AnnAdjustPoint, L_AnnChangeUserHandle, L_AnnConvert, L_AnnDefine2, L_AnnDeleteUserHandle, L_AnnEnumerateHandles, L_AnnGetRestrictToContainer, L_AnnGetRotateAngle, L_AnnGetUserHandle, L_AnnGetUserHandles, L_AnnHitTest, L_AnnRestrictCursor, L_AnnSetRestrictToContainer

Topics:

Annotation Functions: Creating and Deleting Annotations

 

Annotation Functions: Object Information

 

Implementing Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Implementing Custom Annotations

Example

For an example ,refer to L_AnnCreate.