API referenceForms

pdfGetSaveNewImageFormat

Get/set the document-wide policy flag controlling whether

C
BOOL32 __stdcall pdfGetSaveNewImageFormat(PPDF IPDF);
BOOL32 __stdcall pdfSetSaveNewImageFormat(PPDF IPDF, BOOL32 Value);
Delphi
function pdfGetSaveNewImageFormat(const IPDF: PPDF): LongBool; stdcall;
function pdfSetSaveNewImageFormat(const IPDF: PPDF; Value: LongBool): LongBool; stdcall;

Purpose. Get/set the document-wide policy flag controlling whether newly embedded images are allowed to use this SDK's modern default encoding, as opposed to a legacy-compatible one.

Description. A plain boolean field (FSaveNewImageFmt) with no further indirection — pdfGetSaveNewImageFormat reads it, pdfSetSaveNewImageFormat writes it (the setter always returns True, regardless of Value). Defaults to True — note this differs from the classic API's default for this flag. This chapter did not trace every read site of FSaveNewImageFmt in the image-embedding path (that belongs to V07 Images); here it is documented purely as the flag's accessor pair.

Parameters.

ParameterDescription
IPDFDocument handle.
Value*(Set only)* New flag state.

Return value. Getter: current flag state (True by default). Setter: always True.

C# (P/Invoke)

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

Getters

Exported names

pdfGetSaveNewImageFormat

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.