L_AnnLoadMulti

Show in webframe

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnLoadMulti(pFile, phObjects, nCount, pnItemsRead, pLoadOptions)

L_TCHAR * pFile;	/* name of the file to load */
pHANNOBJECT phObjects;	/* address of the variable to be updated */
L_INT nCount;	/* the size of the phObjects array */
L_INT *pnItemsRead;	/* number of items successfully read */
pLOADFILEOPTION pLoadOptions;	/* pointer to optional extended load options */

Loads the specified annotation file.

Parameter	Description
pFile	Name of the file to load.
phObjects	Pointer to an array that will receive the annotation container objects.
nCount	Size of the phObjects array.
pnItemsRead	Pointer to an L_INT that will receive the count of annotation containers successfully read
pLoadOptions	Pointer to optional extended load options. Pass NULL because this parameter is currently ignored.

Returns

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

Comments

To use this function:

Call the L_AnnLoadMulti function and pass NULL for phObjects, and 0 for nCount.
The required size of the array phObjects array is returned in the L_INT pointed to by pnItemsRead.
Allocate an array of HANNOBJECT that can hold *pnItemsRead.
Call the L_AnnLoadMulti function a second time, and pass the allocated array for phObjects.

This function loads all pages of a multi-page annotation file into an array. Each consecutive page of the multi-page annotation file corresponds to one annotation container, which is loaded into consecutive slots of the array. If the annotation file contains many pages, then this function will load the multi-page annotation file much faster than repeated calls to L_AnnLoad function. Note that this function only loads annotation files that use the ANNFMT_XML format.

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

Win32, x64.

See Also

Functions:	L_AnnDeletePage, L_AnnDeletePageMemory, L_AnnDeletePageOffset, L_AnnFileInfo, L_AnnFileInfoMemory, L_AnnFileInfoOffset, L_AnnLoadMemory, L_AnnLoadOffset, L_AnnDestroy, L_AnnSetOptions, L_AnnGetOptions, L_AnnLoad
Topics:	Annotation Files
	Annotation Functions: Input and Output
	Implementing Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Annotation Features
	Annotation Functions: Loading Annotation Files

Example

For an example, refer to L_AnnSaveMulti