API referenceCore SDK

pdfBeginPageTemplate

Begin capturing content into a named page template

C
BOOL32 __stdcall pdfBeginPageTemplate(PPDF IPDF, const char* Name, BOOL32 UseAutoTemplates);
Delphi
function pdfBeginPageTemplate(const IPDF: PPDF; const Name: PAnsiChar; UseAutoTemplates: LongBool): LongBool; stdcall;

Purpose. Begin capturing content into a named page template (distinct from the numeric-handle templates above — addressed by name, intended for auto-placement-by-name workflows).

Description. UseAutoTemplates is accepted by the ABI but never passed through to BeginPageTemplateH — whatever toggle it implies (e.g. whether other registered auto-templates also get placed on pages using this one) has no effect regardless of value.

Parameters.

ParameterDescription
IPDFDocument handle.
NameThe named template's identifier.
UseAutoTemplatesAccepted but silently dropped.

Return value. True if IPDF is valid.

See also. pdfClearAutoTemplates.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Core SDK
Category

Core

Exported names

pdfBeginPageTemplate

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.