AddStructureNamespace

Tagged PDF, PDF compatibility

Description

Registers a structure namespace URI and returns its document-local identifier

Syntax

Delphi

Function TPDFlib.AddStructureNamespace(Const NamespaceURI: WideString): Integer;

DLL

Function DLAddStructureNamespace(InstanceID: Integer; NamespaceURI: PWideChar): Integer; Stdcall;

ActiveX

Function PDFlib::AddStructureNamespace(NamespaceURI As String) As Long

Parameters

NamespaceURIUnique namespace URI stored in the PDF 2.0 /Namespace dictionary

Return values

0No document is selected or the URI is empty
Positive valueThe one-based namespace identifier; registering the same URI again returns the existing identifier

Remarks

The method raises the effective PDF version to 2.0 and writes registered namespaces to StructTreeRoot/Namespaces when the structure tree is saved

See also

SetDefaultStructureNamespace, AddRoleMapNS, GetStructureNamespaceURI