API referenceCore SDK

pdfCreateStructureTree

Open the document-root structure element with the default root

CategoryTagged PDF / structure tree

Purpose — Open the document-root structure element with the default root tag, starting the tagged-PDF structure tree.

Description — Forwards to pdfCreateStructureTreeEx with RootTag=btDocument — the LumasPDF-compatible ABI (which has no RootTag parameter on the base call) always uses the document tag as root.

Declarations

C
BOOL32 __stdcall pdfCreateStructureTree(PPDF IPDF);
Delphi
function pdfCreateStructureTree(const IPDF: PPDF): LongBool; stdcall; external 'LumasPdf.dll';

Return valueTRUE on success; FALSE if a structure tree already exists on this instance (only one root is allowed) or the handle is invalid.

See alsopdfCreateStructureTreeEx

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Core SDK
Category

Object Creation

Exported names

pdfCreateStructureTree

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.