THPDFSanitiseReport Record

Per-category removal counts, work limits and object graph health for a loaded-document sanitisation run

Declaration

THPDFSanitiseReport= record
  Profile: THPDFSanitiseProfile;
  ActionsRemoved: Integer;
  JavaScriptEntriesRemoved: Integer;
  EmbeddedFilesRemoved: Integer;
  RiskyAnnotationsRemoved: Integer;
  XFAEntriesRemoved: Integer;
  PayloadStreamsRemoved: Integer;
  ReferencesRemoved: Integer;
  UnreachableObjectsRemoved: Integer;
  MetadataEntriesRemoved: Integer;
  RedactAnnotationsRemoved: Integer;
  PriorRevisionBytesDiscarded: Int64;
  ObjectsVisited: Integer;
  Changed: boolean;
  LimitExceeded: boolean;
  InvalidObjectGraph: boolean;
end;

Unit

HPDFDoc

Fields

Field	Purpose
`Profile`	Sanitisation policy that was applied, running from `spJavaScriptOnly` to `spRedactionCleanup`
`ActionsRemoved`	Document, page and field actions that were deleted
`JavaScriptEntriesRemoved`	JavaScript entries stripped out of the document's name tree
`EmbeddedFilesRemoved`	Embedded file attachments that were deleted
`RiskyAnnotationsRemoved`	Annotation types the profile classes as risky, such as Launch or Movie
`XFAEntriesRemoved`	XFA entries dropped out of the Catalog
`PayloadStreamsRemoved`	Executable or untrusted payload streams that were removed
`ReferencesRemoved`	Dangling references left behind and pruned away by the pass
`UnreachableObjectsRemoved`	Orphaned objects dropped out of the rewritten file
`MetadataEntriesRemoved`	Metadata entries the profile goes after, such as document info or XMP pieces
`RedactAnnotationsRemoved`	Leftover redaction annotations cleaned away so that marked content is not recoverable
`PriorRevisionBytesDiscarded`	Bytes of prior incremental revisions a full rewrite no longer carries
`ObjectsVisited`	Objects examined whilst the object graph was being rewritten
`Changed`	True where the document content was actually modified
`LimitExceeded`	True where a work budget stopped the pass before it could complete
`InvalidObjectGraph`	True where the source object graph was too damaged for a safe rewrite

Usage notes

Fill it with SanitiseLoadedDocument and one of the THPDFSanitiseProfile policies; the profile decides which counters are allowed to move
Changed is the flag to log in audit trails; the individual counters set out exactly what was stripped
Where InvalidObjectGraph is set the run fails closed rather than producing a half-cleaned document, so follow up with diagnostic repair

THPDFSanitiseReport Record

Declaration

Unit

Fields

Usage notes

Related APIs