pdfCreateStructureTreeEx

Purpose — Open the document-root structure element with an explicit root tag.

Description — Fails immediately if a structure tree already exists (StructElemCount > 0) — this can only be called once per instance, as the very first structure operation. On success it also opens the root element onto the open-tag stack (equivalent to an implicit pdfOpenTag(RootTag)), so pdfSetTagID/pdfSetStructElemTitle called immediately after this apply to the root element.

Declarations

BOOL32 __stdcall pdfCreateStructureTreeEx(PPDF IPDF, TPDFBaseTag RootTag);

function pdfCreateStructureTreeEx(const IPDF: PPDF; RootTag: TPDFBaseTag): LongBool; stdcall; external 'LumasPdf.dll';

TPDFBaseTag (from Lumas.Pdf.Types; a subset of the ISO 32000 standard structure types):

TPDFBaseTag = (btArt, btArtifact, btAnnot, btBibEntry, btBlockQuote,
               btCaption, btCode, btDiv, btDocument, btFigure, btForm,
               btFormula, btH, btH1, btH2, btH3, btH4, btH5, btH6, btIndex,
               btLink, btList, btListElem, btListText, btNote, btP, btPart,
               btQuote, btReference, btSection, btSpan, btTable,
               btTableDataCell, btTableHeader, btTableRow, btTOC, btTOCEntry,
               btCL, btLabel, btRuby, btWarichu, btAbbr, btCallout, btDek,
               btEm, btLineNum, btReason, btRedaction, btSidebar, btStrong,
               btSub, btSup);

Parameters

Return value — TRUE on success; FALSE if a structure tree already exists, there's no open content stream to write the opening BDC operator into, or the handle is invalid.

See also — pdfOpenTag (V12 tagged-PDF chapter), pdfSetTagID

C# (P/Invoke)

[return: MarshalAs(UnmanagedType.Bool)]