API referenceCore SDK

pdfSetStructElemTitle

Set the /T (Title) attribute on the currently-open structure

CategoryTagged PDF / structure tree

Purpose — Set the /T (Title) attribute on the currently-open structure element.

Description — Same current-tag targeting rule as pdfSetTagID (top of the open-tag stack, or the most-recently-registered element).

Declarations

C
int32_t __stdcall pdfSetStructElemTitle(PPDF IPDF, const char* Title);
int32_t __stdcall pdfSetStructElemTitleA(PPDF IPDF, const char* Title);
int32_t __stdcall pdfSetStructElemTitleW(PPDF IPDF, const wchar_t* Title);
Delphi
function pdfSetStructElemTitleA(const IPDF: PPDF; Title: PAnsiChar): Integer; stdcall; external 'LumasPdf.dll';
function pdfSetStructElemTitleW(const IPDF: PPDF; Title: PWideChar): Integer; stdcall; external 'LumasPdf.dll';

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
TitlestringNew /T value for the current tag.

Return value1 on success, 0 on failure (no structure elements exist yet, or the handle is invalid).

See alsopdfSetStructElemID

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfSetStructElemTitleW(IntPtr IPDF, IntPtr Title);
public static extern int pdfSetStructElemTitle(IntPtr IPDF, IntPtr Title);
public static extern int pdfSetStructElemTitleA(IntPtr IPDF, IntPtr Title);
Area
Core SDK
Category

Setters

Exported names

pdfSetStructElemTitleW pdfSetStructElemTitle pdfSetStructElemTitleA

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.