API referenceAnnotations

pdfImportBookmarks

Copy the currently open import file's entire outline tree

C
int32_t __stdcall pdfImportBookmarks(PPDF IPDF);
Delphi
function pdfImportBookmarks(const IPDF: PPDF): Integer; stdcall;

Purpose. Copy the currently open import file's entire outline tree into this document.

Description. Requires an import file to already be open (pdfOpenImportFile, PDF Import); fails with a distinct NO_IMPORT_ERR sentinel if none is open, rather than the generic 0/False failure convention used elsewhere.

Return value. The number of bookmarks imported on success; NO_IMPORT_ERR if no import file is open; 0 if IPDF is invalid.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfImportBookmarks(IntPtr IPDF);
Area
Annotations
Category

Import

Exported names

pdfImportBookmarks

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.