L_AnnSaveMemory

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSaveMemory(hObject, uFormat, fSelected, phMem, puMemSize, pSaveOptions)

Saves the specified annotations to a file in memory.

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

Returns

Comments

In version 15.0, the text based format ANNFMT_XML is replacing ANNFMT_NATIVE and ANNFMT_ENCODED.  Note that ANNFMT_NATIVE and ANNFMT_ENCODED are no longer supported as options with L_AnnSave, L_AnnSaveOffset, and L_AnnSaveMemory.

For backward compatibility, this latest version of LEADTOOLS can read the discontinued formats (ANNFMT_NATIVE and ANNFMT_ENCODED) with the following functions:

L_AnnLoad

L_AnnLoadOffset

L_AnnLoadMemory

L_AnnDeletePage

L_AnnDeletePageOffset

L_AnnDeletePageMemory

The ANNFMT_XML format offers many advantages over the older annotation formats:

• Both forward and backward compatible.

• It is human readable.

• It can be easily modified using a standard text editor (i.e. notepad.exe).

• It can be easily parsed using any standard XML parser.

• It can be used with any of the growing number of utilities that work with XML.

Save annotations in the WMF format only for use in another application. LEADTOOLS reads annotations only in the native format.

To retain scaling and positioning information, this function always saves the root container, along with the specified object or selected objects. Use the hObject and fSelected parameters as follows:

• To save the specified object, set hObject to that object and set fSelected to FALSE.

• To save only selected objects in a container, set hObject to the container and set fSelected to TRUE.

• To save all objects in a container, set hObject to the container and set fSelected to FALSE.

• L_AnnSaveTag is an alternative to L_AnnSaveMemory and L_AnnSetTag, if you are going to save it as a TIF or WANG tag format

Both the ANNFMT_TIFFTAG and the ANNFMT_WANGTAG can be saved inside a TIFF file using L_SetTag with uTag set to ANNTAG_TIFF and uType set to TAG_BYTE.

To detect whether a TIF file has annotation information, you should call L_ReadFileTag and see if ANNTAG_TYPE is present.

If uFormat is ANNFMT_XML, phMem is updated with a memory handle to the annotation file in memory.

If uFormat is ANNFMT_TIFFTAG or ANNFMT_WANGTAG, phMem is updated with a memory handle to the tag.

If you save a memory handle to a tag in TIF or WANG format, using L_AnnSaveMemory, you must write the memory handle to the tag into a file using L_SetTag and L_SaveBitmapMemory before you can load it using the L_AnnLoadMemory function.

If this function returns SUCCESS and phMem is updated with NULL, there are no annotations objects to save.

The information in the SAVEFILEOPTION structure can be used to add new pages or replace existing pages in a multi-page annotation file of type ANNFMT_XML. Note that all the pages of an annotation multi-page file must be all of type ANNFMT_XML. An annotation file cannot contain pages of different format types.

To insert new pages to an annotation multi-page file:

To replace an existing page in an annotation multi-page file:

To delete a page from an annotation multi-page file, use L_AnnDeletePage, L_AnnDeletePageMemory, L_AnnDeletePageOffset.

When adding or replacing an annotation page in an existing memory file, pass the address of a valid HGLOBAL hMem (non zero). When creating a new memory file, declare a variable of type HGLOBAL and set it to zero before passing the address to L_AnnSaveMemory.

Required DLLs and Libraries

Platforms

Windows 2000 / XP/Vista.

See Also

Example

For another example, refer to L_AnnFileInfoMemory.

 L_INT AnnSaveMemoryExample(HWND       hWnd,HANNOBJECT hContainer)
{
   HANNOBJECT  TmpContainer;  /* Temporary container for the annotations */
   HGLOBAL     hTag;          /* Memory handle */
   L_SIZE_T    zMemSize;      /* Size of the data in memory */
   L_UCHAR*    pData;         /* Pointer to the data in memory */
   L_INT       nRet;
   HDC         hdc;
   RECT        rAnnBounds;
   RECT        rAnnBoundsName;

   /* Load the initial annotations  */
   nRet = L_AnnLoad(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\TEST.ANN"), &TmpContainer, NULL);
   if(nRet != SUCCESS)
      return nRet;
   /* Save the annotations as a TIFF TAG in memory */
   hTag = 0;
   nRet = L_AnnSaveMemory(TmpContainer, ANNFMT_TIFFTAG, FALSE, &hTag, &zMemSize, NULL);
   if(nRet != SUCCESS)
      return nRet;

   /* Get the pointer to the memory-resident tag */
   pData = (L_UCHAR*) GlobalLock (hTag);

   /* Set the tag so when the bitmap is saved as TIFF, the tag
      is also saved */
   nRet = L_SetTag(ANNTAG_TIFF, TAG_BYTE, (L_UINT) zMemSize, pData);
   if(nRet != SUCCESS)
      return nRet;

   /* Destroy the temporary container */
   nRet = L_AnnDestroy(&TmpContainer, ANNFLAG_RECURSE);
   if(nRet != SUCCESS)
      return nRet;

   /* Load the new file from memory  */
   nRet = L_AnnLoadMemory(pData, zMemSize, &TmpContainer, NULL);
   
   if (nRet == SUCCESS)
   {
     /* Insert the annotations  into the main container, hContainer, so they will be active. */
     nRet = L_AnnInsert(hContainer, TmpContainer, TRUE);
     if(nRet != SUCCESS)
        return nRet;
     hdc = GetDC(hWnd);
     nRet = L_AnnGetBoundingRect(hContainer, &rAnnBounds, &rAnnBoundsName);
     if(nRet != SUCCESS)
        return nRet;
     nRet = L_AnnDraw(hdc, &rAnnBounds, hContainer);
     if(nRet != SUCCESS)
        return nRet;
   }
   else
      return nRet;

   /* Clean up */
   GlobalUnlock (hTag);
   GlobalFree (hTag);
   return SUCCESS;
}