`pdfChangeNamedDest`

Rename an existing named destination.

Exported names	`pdfChangeNamedDestA`, `pdfChangeNamedDestW`
Availability	Partial — `ObjType` parameter unused — see Remarks

Purpose — Rename an existing named destination.

Description — Overwrites the name at Handle in the named-destination table (FNDName); page and view parameters are unchanged.

Declarations

BOOL32 __stdcall pdfChangeNamedDestA(void* IPDF, TObjType ObjType, uint32_t Handle, const char* NewDestName);
BOOL32 __stdcall pdfChangeNamedDestW(void* IPDF, TObjType ObjType, uint32_t Handle, const wchar_t* NewDestName);

Delphi

function pdfChangeNamedDestA(const IPDF: Pointer; ObjType: TObjType; Handle: Cardinal; const NewDestName: PAnsiChar): LongBool; stdcall; external 'LumasPdf.dll';
function pdfChangeNamedDestW(const IPDF: Pointer; ObjType: TObjType; Handle: Cardinal; const NewDestName: PWideChar): LongBool; stdcall; external 'LumasPdf.dll';

Parameters

Parameter	Type	Description
`IPDF`	`Pointer`	Instance handle.
`ObjType`	`TObjType`	Accepted for ABI compatibility; not read by this build — see Remarks.
`Handle`	`Cardinal`	1-based named-destination handle from `pdfCreateNamedDest`.
`NewDestName`	string	Replacement name. Empty is rejected.

Return value — TRUE on success; FALSE if Handle is out of range or NewDestName is empty.

Remarks — compatibility parameters. ObjType (the reference ABI's object-kind discriminator, presumably intended to allow this call to target different destination-bearing object types) is accepted but ignored; this build always applies the rename to the single named-destination table regardless of its value.

See also — pdfCreateNamedDest

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

[return: MarshalAs(UnmanagedType.Bool)]

Area

Core SDK