THPDFSanitiseReport Record

Per-category removal counts, work limits, and object graph health for a loaded-document sanitization 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`	Sanitization policy that was applied, from `spJavaScriptOnly` to `spRedactionCleanup`
`ActionsRemoved`	Document, page, and field actions deleted
`JavaScriptEntriesRemoved`	JavaScript entries stripped from the document's name tree
`EmbeddedFilesRemoved`	Embedded file attachments deleted
`RiskyAnnotationsRemoved`	Annotation types the profile classifies as risky, such as Launch or Movie
`XFAEntriesRemoved`	XFA entries dropped from the Catalog
`PayloadStreamsRemoved`	Executable or untrusted payload streams removed
`ReferencesRemoved`	Dangling references left behind and pruned by the pass
`UnreachableObjectsRemoved`	Orphaned objects dropped from the rewritten file
`MetadataEntriesRemoved`	Metadata entries the profile targets, such as document info or XMP pieces
`RedactAnnotationsRemoved`	Leftover redaction annotations cleaned up so marked content is not recoverable
`PriorRevisionBytesDiscarded`	Bytes of prior incremental revisions that a full rewrite no longer carries
`ObjectsVisited`	Objects examined while rewriting the object graph
`Changed`	True when the document content was actually modified
`LimitExceeded`	True when a work budget stopped the pass before completion
`InvalidObjectGraph`	True when 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 can move
Changed is the flag to log in audit trails; the individual counters explain exactly what was stripped
When 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