LAnnContainer::SaveTag

Summary

Copies the annotation objects into a memory location so that the next TIFF saved will contain these annotations in a Wang compatible TIFF tag.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnContainer::SaveTag(uFormat=ANNFMT_TIFFTAG, bSelected=FALSE)

Parameters

L_UINT uFormat

Format for saving annotation data. Possible values are:

Value Meaning
ANNFMT_TIFFTAG [0x0002] Save the object in WANG format, along with all LEAD properties not supported by the Wang specification.
ANNFMT_WANGTAG [0x0003] Save only the properties supported by the Wang specification.

L_BOOL bSelected

Flag that indicates which objects to save. Possible values are:

Value Meaning
TRUE Save all objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
FALSE Save only the specified object.

Returns

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

Comments

After calling this function, saving an image as a TIFF format will cause the annotations to be saved in a tag in the TIFF file.

The annotations will not be saved unless you also save an image in one of the TIFF formats:

This tag can be cleared using LFileSettings::SetTag.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

L_INT LAnnContainer_SaveTagExample(LAnnContainer& LeadAContainer) 
{ 
  
   L_INT nRet; 
 
   // set Wang Compatibility mode for annotations 
 
   nRet = LeadAContainer.SaveTag( ANNFMT_WANGTAG, FALSE); 
 
   if(nRet != SUCCESS) 
   { 
      MessageBox(NULL, TEXT("Error creating annotation data.\n The file will be saved without annotations.\n\n"),TEXT("Annotation Error"),MB_OK); 
      return nRet; 
   } 
    
 
   return SUCCESS; 
} 
Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.