API referencePDF/A & Conformance

pdfAddObjRefToStruct

Bind an annotation to the currently-open structure element

C
BOOL32 __stdcall pdfAddObjRefToStruct(PPDF IPDF, uint32_t Annot);
Delphi
function pdfAddObjRefToStruct(const IPDF: PPDF; Annot: Cardinal): LongBool; stdcall;

Purpose. Bind an annotation to the currently-open structure element as an /OBJR (object reference) child — the tagged-PDF mechanism for associating a non-text marked-content object (like an annotation) with its place in the accessibility structure tree.

Description. Requires a structure tag to already be open (via pdfOpenTag, V03) — operates on "the open struct element," not an explicit tag handle parameter.

Parameters.

ParameterDescription
IPDFDocument handle.
AnnotThe annotation handle to bind as an /OBJR child of the currently-open tag.

Return value. True on success (a tag was open and the binding was added).

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
PDF/A & Conformance
Category

Content Creation

Exported names

pdfAddObjRefToStruct

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.