GetAuditFindingDetail

Diagnostics

Description

Returns the human-readable explanation of one finding from the most recent structural audit call

Syntax

Delphi

Function GetAuditFindingDetail(Index: Integer): WideString;

Parameters

IndexZero-based index of the cached finding to read

Return values

DetailThe diagnostic explanation supplied by the audit pass
Empty stringIndex is negative or out of range, including when no audit findings are cached

Remarks

Combine the detail with GetAuditFindingSeverity and GetAuditFindingItem when presenting an audit report; every Audit* call replaces the cached findings

Example

Memo1.Lines.Add(PDF.GetAuditFindingDetail(I));

See also

GetAuditFindingCount, GetAuditFindingSeverity, GetAuditFindingItem, AuditStreamLengths