DeleteAnnotation

Annotations and hotspot links

Description

Removes an annotation from the selected page.

Syntax

Delphi

function TPDFlib.DeleteAnnotation(Index: Integer): Integer;

ActiveX

Function PDFlib::DeleteAnnotation(Index As Long) As Long

DLL

int DLDeleteAnnotation(int InstanceID, int Index);

Parameters

IndexThe index of the annotation to delete. The first annotation on the page has an index of 1. The AnnotationCount function returns the total number of annotations on the selected page.

Return values

0The specified annotation could not be deleted. Check the value of the Index parameter is between 1 and the value returned by the AnnotationCount function.
1The specified annotation was deleted from the page successfully.