THPDFCustomStreamFilterRequest

Provides immutable invocation context to a custom stream filter

Declaration

THPDFCustomStreamFilterRequest = record
  FilterName: AnsiString;
  FilterIndex: Integer;
  PipelineDepth: Integer;
  InputBytes: Int64;
  MaxOutputBytes: Int64;
  CancellationToken: THPDFCancellationToken;
end;

Parameters

FilterName is the decoded PDF name, FilterIndex is zero based, and PipelineDepth identifies nested decode depth

InputBytes is zero when size is unavailable, while MaxOutputBytes is the remaining aggregate allowance and zero means unlimited

Return value

This record does not return a value

Usage notes

• Treat every field as read only
• The cancellation token is borrowed and valid only during the callback
• The pipeline still enforces output budgets even when a filter ignores MaxOutputBytes

Related APIs

• IHPDFCustomStreamFilter
• Custom Stream Filter Registry