DeleteBookmark Method of the Paragraph Object

DeleteBookmark method of the Paragraph Object in the ABBYY FineReader Engine API — Deletes a bookmark (technical or user) from the paragraph by its prefixed name.

This method deletes the specified bookmark of any type (technical or user) from the paragraph. You must specify its name with the prefix.

Syntax

C++

HRESULT DeleteBookmark( BSTR Bookmark );

C#

void DeleteBookmark( string Bookmark );

Visual Basic .NET

Sub DeleteBookmark(Bookmark As String)

Parameters

Bookmark

[in] This variable specifies the bookmark to be deleted.

Remarks

The user bookmarks to be deleted must be specified in the format “UserDefinedBookmark:<my_user_bookmark>“:

// Create bookmark
paragraph->SetBookmark( 0, count, L"my_user_bookmark" );
//...
//Delete bookmark
paragraph->DeleteBookmark( L"UserDefinedBookmark:my_user_bookmark" );

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Paragraph