L_DispContainerGetAnnotationContainer

#include "l_bitmap.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetAnnotationContainer(hCon, nCellIndex, nSubCellIndex, PhAnnContainer, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of the cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
HANNOBJECT * PhAnnContainer;	/* address of the variable to be updated */
L_UINT uFlags;	/* reserved for future */

Gets the annotation container for the specific frame.

Parameter	Description
hCon	Handle to the Container.
nCellIndex	A zero-based index of the cell for which to retrieve the annotation container. Pass -2 to get the annotation container of the selected cells.
nSubCellIndex	A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell contains the image that contains the annotation container. Pass -2 to refer to the selected sub-cell.
PhAnnContainer	Address of the variable to be updated with the handle to the annotation object that is found at the specified point.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

This function gets a copy of the annotation container. You must free it once it is no longer needed.

This function gets the annotation container. To set the annotation container use L_DispContainerSetAnnotationContainer.

Required DLLs and Libraries

LTIVW
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:	L_DispContainerRotateAnnotationContainer, L_DispContainerSetAnnotationContainer, L_DispContainerAnnToRgn, L_DispContainerGetSelectedAnnotationAttributes, L_DispContainerSetAnnotationCallBack, L_DispContainerGetAnnotationCallBack, L_DispContainerGetAnnotationCreatedCallBack, L_DispContainerSetAnnotationCreatedCallBack, DISPCONTAINERANNOTATIONCALLBACK, DISPCONTAINERANNOTATIONCREATEDCALLBACK
Topics:	Image Viewer Cells
	Image Viewer Functions: Image Viewer Cells

Example

This example will copy the annotation container from the specified sub-cell clicked by the user using the left mouse button, and paste the annotation container on the specified sub-cell clicked by the user using the right mouse button.

HANNOBJECT hContainer;
static L_INT EXT_CALLBACK MouseCallBack(L_UINT                 uMessage,
                                 pDISPCONTAINERCELLINFO pCellInfo,
                                 L_VOID *               pUserData)
{
   UNREFERENCED_PARAMETER(pCellInfo);
   HDISPCONTAINER hCon = (HDISPCONTAINER)pUserData;

   switch(uMessage)
   {
   case WM_LBUTTONUP:
         L_DispContainerGetAnnotationContainer(hCon, pCellInfo->nCellIndex, pCellInfo->nSubCellIndex, &hContainer, 0);
      break;

   case WM_RBUTTONUP:
         L_DispContainerSetAnnotationContainer(hCon, pCellInfo->nCellIndex, pCellInfo->nSubCellIndex, hContainer, 0);
      break;
   }

   return SUCCESS;
}

L_INT DispContainerGetAnnotationContainerExample(HDISPCONTAINER hCon)
{
   DISPCONTAINERMOUSECALLBACK oldCallBack;
   L_VOID *                   pOldUserData;

   L_DispContainerGetMouseCallBack(hCon, &oldCallBack, &pOldUserData);

   L_DispContainerSetMouseCallBack(hCon, MouseCallBack, hCon);

   return SUCCESS;
}