L_AnnGetAutoContainer

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoContainer(hObject, phContainer)

HANNOBJECT hObject;

/* handle to an annotation automation object */

pHANNOBJECT *phContainer;

/* address of the variable to be updated */

Gets the handle of the container for the automation object. The automation object is used to implement default properties.

This function is available in the Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to an annotation automation object.

phContainer

Address of the HANNOBJECT variable to be updated with the handle of the automation objects 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

The automation object is associated with a root container but is not in the container.

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 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

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnCreate, L_AnnSetAutoContainer, L_AnnSetDpiX,

 

L_AnnSetDpiY, L_AnnGetDpiX, L_AnnGetDpiY,

 

L_AnnSetTool, L_AnnGetTool, L_AnnGetUserMode,

 

L_AnnSetUserMode, L_AnnSetUndoDepth, L_AnnUndo, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor, L_AnnCalibrateRuler, L_AnnCalibrateRulerSuccessive

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Obtaining Annotation Object Information

 

Annotation Functions (Document/Medical only): Automation Properties

Example

This example gets the automation object's container and assigns it to a global variable. 

 L_INT AnnGetAutoContainerExample(HANNOBJECT hAutoObject,
                                                HANNOBJECT hContainer)/* Container annotation object */
{
   HANNOBJECT  ThisContainer; /* Automation object's container */
   L_INT       nRet;          /* Return value */

   /* Get the automation object's container */
   nRet = L_AnnGetAutoContainer(hAutoObject, &ThisContainer);
   /* Assign the object to the global Container variable */
   if (nRet == SUCCESS)
      hContainer = ThisContainer;
   else
   {
      MessageBox (NULL, TEXT("Automation object has no container"), TEXT("Error"), MB_OK);
      return nRet;
   }
   return SUCCESS;
}