L_AnnDeletePage

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnDeletePage(pFile, nPage)

L_TCHAR *pFile;

/* file name */

L_INT32 nPage;

/* page to delete */

Deletes a page from an annotation file containing multiple pages.

Parameter

Description

pFile

Character string containing the name of the annotation file.

nPage

Number of the page to delete. The page number is 1-based. Therefore, the first page is page 1, the second page is page 2, etc.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function can be used to remove annotation pages from a multi-page annotation file. The page number is 1-based. Therefore, the first page is page 1, the second page is page 2, and so on. This function can be used for LEAD annotation files (ANNFMT_NATIVE, ANNFMT_ENCODED, or ANNFMT_XML). To determine the format for a particular LEAD annotation file, use L_AnnFileInfo.

Required DLLs and Libraries

LTDIS

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 2000 / XP/Vista.

See Also

Functions:

L_AnnDeletePageMemory, L_AnnDeletePageOffset, L_AnnFileInfoMemory, L_AnnFileInfoOffset, L_AnnLoad, L_AnnLoadOffset, L_AnnLoadMemory, L_AnnSave, L_AnnSaveOffset, L_AnnSaveMemory

Topics:

Annotation Files

 

Annotation Functions: Input and Output

 

Implementing Annotations

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

Example

For an example, refer to L_AnnFileInfo.