API referenceForms

pdfGetFieldToolTip

Get/set a field's /TU tooltip (alternate description)

C
int32_t __stdcall pdfGetFieldToolTip(PPDF IPDF, uint32_t AField, void* Value, BOOL32* Unicode);
BOOL32 __stdcall pdfSetFieldToolTipA(PPDF IPDF, uint32_t AField, const char* Value);
BOOL32 __stdcall pdfSetFieldToolTipW(PPDF IPDF, uint32_t AField, const wchar_t* Value);
Delphi
function pdfGetFieldToolTip(const IPDF: PPDF; AField: Cardinal; var Value: Pointer; var Unicode: LongBool): Integer; stdcall;
function pdfSetFieldToolTipA(const IPDF: PPDF; AField: Cardinal; Value: PAnsiChar): LongBool; stdcall;
function pdfSetFieldToolTipW(const IPDF: PPDF; AField: Cardinal; Value: PWideChar): LongBool; stdcall;

Purpose. Get/set a field's /TU tooltip (alternate description) text.

Description. pdfGetFieldToolTip's Unicode output is always forced False (QueryFieldToolTip exposes ANSI only) — the same one-sided limitation confirmed repeatedly for other getters in this volume (pdfGetFieldMapName, Field Naming, Identity, and Flags; pdfGetTextFieldValue, Field Values), while the setters genuinely accept both A/W.

Parameters.

ParameterDescription
IPDFDocument handle.
AFieldTarget field handle.
Value*(Get)* Output, always narrow despite Unicode's presence. *(Set)* New tooltip text.
Unicode*(Get only)* Output: always False.

Return value. pdfGetFieldToolTip: text length; 0 if AField doesn't resolve. pdfSetFieldToolTip: True on success.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfGetFieldToolTip(IntPtr IPDF, uint AField, ref IntPtr Value, [MarshalAs(UnmanagedType.Bool)] ref bool Unicode);
Area
Forms
Category

Forms

Exported names

pdfGetFieldToolTip

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.