API referenceImages

pdfSetFindImagesMode

Set a document-global "find images" mode value.

C
int32_t __stdcall pdfSetFindImagesMode(PPDF IPDF, int32_t NewFindImagesMode);
Delphi
function pdfSetFindImagesMode(const IPDF: PPDF; NewFindImagesMode: Integer): Integer; stdcall;

Purpose. Set a document-global "find images" mode value.

Description. Verified write-only no-op. Stores NewFindImagesMode into FindImagesMode; this field has exactly one reference in the entire codebase — its own declaration and this setter — no getter is even exposed in the ABI, and nothing reads it to alter behavior anywhere. Setting it has no observable effect on any image search, count, or extraction operation in this SDK.

Parameters.

ParameterDescription
IPDFDocument handle.
NewFindImagesModeStored but never read anywhere, and has no corresponding getter.

Return value. 1 if IPDF is valid; 0 otherwise.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfSetFindImagesMode(IntPtr IPDF, int NewFindImagesMode);
Area
Images
Category

Setters

Exported names

pdfSetFindImagesMode

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.