API referenceCore SDK

pdfDAHidePage

Hide a page — per the PDF spec, there is no standard

C
int32_t __stdcall pdfHidePage(PPDF IPDF, int32_t PageNum);
int32_t __stdcall pdfDAHidePage(PPDF IPDF, int32_t FileHandle, int32_t PageRef);
Delphi
function pdfHidePage(const IPDF: PPDF; PageNum: Integer): Integer; stdcall;
function pdfDAHidePage(const IPDF: PPDF; FileHandle, PageRef: Integer): Integer; stdcall;

Purpose. Hide a page — per the PDF spec, there is no standard "hidden page" attribute; both are accepted for ABI compatibility.

Description. Known limitation. Both functions only range-validate PageNum/ PageRef against the page count and return success/failure accordingly — neither actually hides anything (there is nothing in the PDF format for them to set). pdfDAHidePage's FileHandle is, consistent with this volume's other "DA" (Direct Access) functions, accepted but not consulted — always validated against the current document.

Parameters.

ParameterDescription
IPDFDocument handle.
PageNum/PageRef1-based page to validate (no actual hide effect).
FileHandleAccepted but never consulted.

Return value. 1 if the page number is in range; 0 otherwise. Does not indicate any page was actually hidden.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfDAHidePage(IntPtr IPDF, int FileHandle, int PageRef);
Area
Core SDK
Category

Core

Exported names

pdfDAHidePage

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.