API referenceCore SDK

pdfGetDocUsesTransparency

Get/set a document-level "uses transparency" flag consulted

C
BOOL32 __stdcall pdfGetDocUsesTransparency(PPDF IPDF, uint32_t Flags);
BOOL32 __stdcall pdfGetUseTransparency(PPDF IPDF);
BOOL32 __stdcall pdfSetUseTransparency(PPDF IPDF, BOOL32 Value);
Delphi
function pdfGetDocUsesTransparency(const IPDF: PPDF; Flags: Cardinal): LongBool; stdcall;
function pdfGetUseTransparency(const IPDF: PPDF): LongBool; stdcall;
function pdfSetUseTransparency(const IPDF: PPDF; Value: LongBool): LongBool; stdcall;

Purpose. Get/set a document-level "uses transparency" flag consulted when deciding whether to emit PDF-1.4+ transparency-group constructs.

Description. Verified: pdfGetDocUsesTransparency and pdfGetUseTransparency are the literal identical implementation (GetUseTransparency) — despite the different name suggesting a document-content scan ("does this document actually use transparency anywhere"), pdfGetDocUsesTransparency is simply the same stored flag getter with an extra, silently dropped Flags parameter (accepted by the ABI but never consulted).

Parameters.

ParameterDescription
IPDFDocument handle.
Flags*(DocUsesTransparency only)* Accepted but silently dropped.
Value*(Set only)* New flag value.

Return value. True/False per the stored flag; False if IPDF is invalid.

C# (P/Invoke)

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

Getters

Exported names

pdfGetDocUsesTransparency

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.