L_AnnSaveOffset

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSaveOffset(fd, nOffset, puSizeWritten, hObject, uFormat, fSelected, pSaveOptions)

Saves the specified annotations at a specified position in an existing file.

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.

This function overwrites existing data at the specified location in the file. You can use this function to update an image that you loaded with the L_AnnLoadOffset function. The offset is specified in bytes. You must open the file and get a Windows file handle before calling this function.

Before calling this function, you must declare a variable of data type L_UINT32. Then, pass the address of the variable in the puSizeWritten parameter. This function will update the variable with the size of the embedded file.

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.

Required DLLs and Libraries

Platforms

Windows 2000 / XP/Vista.

See Also

Example

This sample saves the contents of hContainer into a file pszFile at offset 30

#include <tchar.h>
 L_INT AnnSaveOffsetExample(L_TCHAR *pszFile, HANNOBJECT hContainer)
{
   HANDLE hFileNew = 0; /* File handle */
   DWORD dwBytesWritten = 0;
   L_INT nRet = SUCCESS;

   if (!pszFile)
      return ERROR_NO_MEMORY ;

   L_SIZE_T SizeWritten = 0; 
   // Create a file
   hFileNew = CreateFile(pszFile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);

   // Write header information -- 29 characters and a terminator
   //_write(NewFile, "This is a 29-character string", 30);
   WriteFile(hFileNew, "This is a 29-character string", 30, &dwBytesWritten, NULL);

   // Save the file with an offset
   nRet = L_AnnSaveOffset( (L_HFILE)hFileNew, 30, &SizeWritten, hContainer, ANNFMT_XML, FALSE, NULL);
   if (nRet == SUCCESS)
      MessageBox(NULL, TEXT("File saved with offset"), TEXT("Notice"), MB_OK);
   else
      return nRet;

   // Close the file
   CloseHandle(hFileNew);

   return SUCCESS;
}