LAnnotation::GetContainer

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetContainer(phContainer)

virtual L_INT LAnnotation::GetContainer(pLContainer)

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

Gets the handle of the Container of the annotation object. This function is available in the Document/Medical Toolkits.

Parameter	Description
phContainer	Address of the HANNOBJECT variable to be updated with the handle of the container. If the object does not have a container, the updated value is NULL.
pLContainer	Pointer to an the LAnnContainer object to be updated with the handle of the container. If the object does not have a container, the updated value is NULL.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Before calling LAnnotation::GetContainer(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 container.

Before calling LAnnotation::GetContainer(pLContainer), you must declare a class object of type LAnnContainer. Then, pass the address of the variable in the pLContainer parameter. This function will update the object with the handle of the annotation object's 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.

See Also

Functions:	Class Members
Topics:	Annotation Functions: Creating and Deleting Annotations
	Annotation Functions: Object Information
	Implementing Annotations
	Displaying and Manipulating Annotation Objects

Example

This is an example for LAnnotation::GetContainer(phContainer):

L_VOID TestGetContainer(LAnnotation& LeadAnn)
{
   HANNOBJECT  hAnnObject ;
   LeadAnn.GetContainer(&hAnnObject) ;

   //...
}

This is an example for LAnnotation::GetContainer(pLContainer):

L_VOID TestGetContainer(LAnnotation& LeadAnn)
{
   LAnnContainer  LeadAContainer ;
   L_UINT         uUserMode ;

   LeadAnn.GetContainer(&LeadAContainer) ;

   uUserMode = LeadAContainer.GetUserMode();
   if (uUserMode != ANNUSER_RUN)
      LeadAContainer.SetUserMode(ANNUSER_RUN);
}