L_AnnGetTopContainer

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTopContainer(hObject, phContainer)

HANNOBJECT hObject;

/* handle to the annotation object */

pHANNOBJECT phContainer;

/* address of variable to be updated */

Gets the handle of the root container of the specified annotation object.

Parameter

Description

hObject

Handle to the annotation object.

phContainer

Address of the HANNOBJECT variable to be updated with the handle of the root container.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phContainer parameter. This function will update the variable with the handle of the annotation object's root 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_AnnInsert, L_AnnRemove, L_AnnGetContainer, L_AnnEnumerate, L_AnnGetItem

Topics:

Annotation Functions: Creating and Deleting Annotations

 

Annotation Functions: Object Information

 

Implementing Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Obtaining Annotation Object Information

Example

For an example, refer to L_AnnGetContainer.