THotPDF.RegisterCustomStreamFilter

Retains an application-defined decoder under its normalised PDF filter name

Declaration

function RegisterCustomStreamFilter(
  const CustomFilter: IHPDFCustomStreamFilter;
  ReplaceExisting: Boolean = False): Boolean;

Parameters

CustomFilter supplies the name, mode, seek contracts and decoder implementation

ReplaceExisting permits an atomic replacement when the normalised name already exists

Return value

Returns True after insertion or replacement and False for a duplicate when replacement is switched off

Usage notes

• Nil interfaces, invalid PDF names, built-in names and a registry beyond 64 entries raise an argument or range exception
• Name matching is case insensitive and ignores one leading slash
• The registry retains the interface until replacement, removal, clearing or document destruction
• Concurrent decode lookup takes an interface snapshot before releasing the registry lock

Related APIs

• IHPDFCustomStreamFilter
• Registry management methods
• Custom Stream Filter Registry