API referenceCore SDK

pdfGetAnalysisInfo

Read/delete a stored "analysis" result item — a generic,

C
const char* __stdcall pdfGetAnalysisInfoA(PPDF IPDF, int32_t AnalysisID, int32_t AnalysisItem);
const wchar_t* __stdcall pdfGetAnalysisInfoW(PPDF IPDF, int32_t AnalysisID, int32_t AnalysisItem);
int32_t __stdcall pdfDeleteAnalysis(PPDF IPDF, int32_t AnalysisID);
Delphi
function pdfGetAnalysisInfoA(const IPDF: PPDF; AnalysisID, AnalysisItem: Integer): PAnsiChar; stdcall;
function pdfGetAnalysisInfoW(const IPDF: PPDF; AnalysisID, AnalysisItem: Integer): PWideChar; stdcall;
function pdfDeleteAnalysis(const IPDF: PPDF; AnalysisID: Integer): Integer; stdcall;

Purpose. Read/delete a stored "analysis" result item — a generic, opaque (AnalysisID, AnalysisItem)-keyed result-string store (this chapter did not independently locate a corresponding "run analysis" creation entry point elsewhere in the inventory; treat AnalysisID as produced by some other document-analysis mechanism not covered here).

Parameters.

ParameterDescription
IPDFDocument handle.
AnalysisIDThe analysis run's identifier.
AnalysisItemWhich result item within that analysis to read.

Return value. pdfGetAnalysisInfo: the item text (transient buffer); nil/empty if not found. pdfDeleteAnalysis: 1 if AnalysisID resolved and was removed; 0 otherwise.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern IntPtr pdfGetAnalysisInfoW(IntPtr IPDF, int AnalysisID, int AnalysisItem);
public static extern IntPtr pdfGetAnalysisInfo(IntPtr IPDF, int AnalysisID, int AnalysisItem);
public static extern IntPtr pdfGetAnalysisInfoA(IntPtr IPDF, int AnalysisID, int AnalysisItem);
Area
Core SDK
Category

Getters

Exported names

pdfGetAnalysisInfoW pdfGetAnalysisInfo pdfGetAnalysisInfoA

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.