LAnnotation::GetTopContainer

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetTopContainer(phContainer)

virtual L_INT LAnnotation::GetTopContainer(pLContainer)

pHANNOBJECT phContainer;	/* address of the HANNOBJECT variable to be updated */
LAnnContainer * pLContainer;	/* pointer to an LAnnContainer object */

Gets the handle of the Root Container of the annotation object.

Parameter	Description
phContainer	Address of the HANNOBJECT variable to be updated with the handle of the root container
pLContainer	Pointer to the LAnnContainer object 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 LAnnotation::GetTopContainer(phContainer), 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.

Before calling LAnnotation::GetTopContainer(pLContainer), you must declare a class object of type LAnnContainer. Then, pass the address of the object in the pLContainer parameter. This function will update the object 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:	Class Members
Topics:	Annotation Functions: Creating and Deleting Annotations
	Annotation Functions: Object Information
	Implementing Annotations
	Displaying and Manipulating Annotation Objects

Example

For an example of LAnnotation::GetTopContainer(phContainer),

refer to LAnnotation::CutToClipboard.

For an example of LAnnotation::GetTopContainer(pLContainer), refer to

LAnnotation::CopyToClipboard.