Both forward and backward compatible.L_AnnSave
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnSave(pFile, hObject, uFormat, fSelected, pSaveOptions)
|
/* name of the file to save */ | |
|
HANNOBJECT hObject; |
/* handle to the root annotation */ |
|
L_UINT uFormat; |
/* file format for saving annotation data */ |
|
L_BOOL fSelected; |
/* flag that indicates which objects to save*/ |
|
pSAVEFILEOPTION pSaveOptions; |
/* pointer to optional extended save options */ |
Saves annotations in the specified file. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
pFile |
Character string containing the name of the file to save. |
|
|
hObject |
Handle to the root annotation object that includes all objects to save in the file. This typically is a container object. |
|
|
uFormat |
Format for saving annotation data. Possible values are: |
|
|
|
Value |
Meaning |
|
|
ANNFMT_NATIVE |
[0x0000] Use LEAD's own format for annotations. NOTE: This format is being replaced by ANNFMT_XML. |
|
|
ANNFMT_WMF |
[0x0001] Use the Windows WMF format. |
|
|
ANNFMT_ENCODED |
[0x0004] Save as a binary format. This file size is smaller and is upward compatible. It also provides better security. |
|
|
ANNFMT_XML |
[0x0005] Save as an XML text format. This is LEAD’s new text based format which is upward compatible. It should be used instead of ANNFMT_NATIVE. |
|
fSelected |
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 L_AnnGetSelected and L_AnnSetSelected functions. |
|
|
FALSE |
Save only the specified object. |
|
pSaveOptions |
Pointer to a SAVEFILEOPTION structure that contains optional extended save options. This information is used to add annotation pages or replace annotation pages in a multi-page annotation file. Pass NULL to save a one page annotation file. |
|
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
In version 14.5, the new text based format ANNFMT_XML is being introduced. It has many advantages over ANNFMT_NATIVE and ANNFMT_ENCODED including:
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.
To save an annotation to a TIF file as a
tag, call L_AnnSaveTag.
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_NATIVE, ANNFMT_ENCODED or ANNFMT_XML. Note that all the pages of an annotation multi-page file must be all of type ANNFMT_NATIVE or all of type ANNFMT_ENCODED or 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:
|
1. |
Declare a variable of type SAVEFILEOPTION. |
|
2. |
Set the uFlags field of the SAVEFILEOPTION structure to ESO_INSERTPAGE. |
|
3. |
Set the PageNumber field of the SAVEFILEOPTION structure to the location for insertion. The new page will be inserted in front of the page specified in the PageNumber field. |
To replace an existing page in an annotation multi-page file:
|
1. |
Declare a variable of type SAVEFILEOPTION. |
|
2. |
Set the uFlags field of the SAVEFILEOPTION structure to ESO_REPLACEPAGE. |
|
3. |
Set the PageNumber field of the SAVEFILEOPTION structure to the page to replace. |
To delete a page from an annotation multi-page file, use L_AnnDeletePage, L_AnnDeletePageMemory, L_AnnDeletePageOffset.
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 95 / 98 / Me, Windows 2000 / XP.
See Also
|
Functions: |
L_AnnDeletePage, L_AnnDeletePageMemory, L_AnnDeletePageOffset, L_AnnFileInfo, L_AnnFileInfoMemory, L_AnnSaveMemory, L_AnnSaveOffset, L_AnnSaveTag, L_AnnSetOptions, L_AnnGetOptions |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
For complete sample code, refer to the ANNOTATE example.
For another example, refer to L_AnnFileInfo.
/* This example saves currently selected annotations in a file */
HANNOBJECT hContainer; /* Container annotation object */
void TestAnnSave (void)
{
int nRet;
nRet = L_AnnSave(TEXT("E:\\LEAD Technologies, Inc\\LEADTOOLS\\TEST.ANN"), hContainer, ANNFMT_NATIVE, FALSE, NULL);
if (nRet == SUCCESS)
MessageBox(NULL, TEXT("Annotations saved"), TEXT("Notice"), MB_OK);
return;
}