API reference › PDF/A & Conformance
pdfAddObjRefToStruct
Bind an annotation to the currently-open structure element
BOOL32 __stdcall pdfAddObjRefToStruct(PPDF IPDF, uint32_t Annot);
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.
| Parameter | Description |
|---|---|
IPDF | Document handle. |
Annot | The 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)
[return: MarshalAs(UnmanagedType.Bool)]
Content Creation
pdfAddObjRefToStruct
The …A form takes UTF-8, …W
takes UTF-16; a bare name aliases the ANSI form.
Worked examples — complete programs in ten languages.