LAnnContainer::SaveTag
#include "ltwrappr.h"
virtual L_INT LAnnContainer::SaveTag(uFormat=ANNFMT_TIFFTAG, bSelected=FALSE)
L_UINT uFormat; |
/* format for saving annotation data */ |
L_BOOL bSelected; |
/* flag that indicates which objects to save */ |
Copies the annotation objects into a memory location so that the next TIFF saved will contain these annotations in a Wang compatible TIFF tag. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
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. |
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
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 (FILE_TIF_JPEG, FILE_LEAD1JTIF, FILE_LEAD2JTIF, FILE_CCITT, FILE_TIF, FILE_TIFLZW, FILE_CCITT_GROUP3_1DIM, FILE_CCITT_GROUP3_2DIM, FILE_CCITT_GROUP4, FILE_TIF_CMYK, FILE_TIFLZW_CMYK, FILE_TIF_PACKBITS, FILE_TIF_PACKBITS_CMYK, FILE_TIF_YYC, FILE_TIFLZW_YYC, FILE_TIF_PACKBITS_YCC).
This tag can be cleared using LFileSettings::SetTag.
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: |
LFile::DeleteTag, LAnnotationWindow::AnnSave, LFile::SaveBitmap, Class Members |
Topics |
Annotation Functions (Document/Medical only): Saving Annotation Files |
Example
L_VOID TestSaveTag(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);
}