In This Topic ▼

L_AnnLoadMulti

Summary

Loads the specified annotation file.

Syntax

#include "l_bitmap.h"

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

Parameters

L_TCHAR * pFile

Name of the file to load.

pHANNOBJECT phObjects

Pointer to an array that will receive the annotation container objects.

L_INT nCount

Size of the phObjects array.

L_INT *pnItemsRead

Pointer to an L_INT that will receive the count of annotation containers successfully read.

pLOADFILEOPTION pLoadOptions

Pointer to optional extended load options. Pass NULL because this parameter is currently ignored.

Returns

Value	Meaning
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 multipage annotation file into an array. Each consecutive page of the multipage 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 multipage 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.