API referencePDF/X & Prepress

pdfGetOutputIntent

Read back a previously-registered output intent's

C
BOOL32 __stdcall pdfGetOutputIntent(PPDF IPDF, uint32_t Index, TPDFOutputIntent* Intent);
int32_t __stdcall pdfGetOutputIntentCount(PPDF IPDF);
Delphi
function pdfGetOutputIntent(const IPDF: PPDF; Index: Cardinal; var Intent: TPDFOutputIntent): LongBool; stdcall;
function pdfGetOutputIntentCount(const IPDF: PPDF): Integer; stdcall;

Purpose. Read back a previously-registered output intent's metadata (component count, output-condition string, ICC profile size) by index, and report how many are registered.

Description. Stale Stub tag corrected — pdfGetOutputIntent is genuinely real, not a non-operational export as the generated reference table's Status: Stub marker claims (the same class of correction made repeatedly elsewhere in this manual — e.g. Signature Fields, PKCS#7/CMS Signing, and RFC-3161 Timestamps's pdfGetSigDict). It reads from the exact same FOutIntents array that all three output-intent creators populate: pdfAddOutputIntent(Ex) (Output Intents, Rich Media/SVG/SWF Annotations, File Attachments, and Misc, the conformance-relevant one, OutCond='sRGB' with a real ICC-header-detected component count) and pdfAddRenderingIntent(Ex) (Rendering Intent and Page Render Entry Points, OutCond='Rendering', always NComps=3) — so an intent added via either creator is equally readable back through this one getter, and Index addresses a single unified list regardless of which creator added each entry.

Parameters.

ParameterDescription
IPDFDocument handle.
Index0-based index into the unified output-intent list.
IntentOutput: NumComps, OutputCondition (transient buffer pointer), OutCondLen, ProfileSize. Note: the raw ICC profile *bytes* themselves are not returned here, only their size — there is no separate getter for the profile data in this volume's API surface.

Return value. pdfGetOutputIntent: True if Index is in range. pdfGetOutputIntentCount: the real count of registered intents (0 if none).

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
PDF/X & Prepress
Category

Getters

Exported names

pdfGetOutputIntent

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.