IHPDFCustomStreamFilter

Definerer en referenceoptalt brugerdefineret dekoder, som bruges af filterpipelines for indlæste streams

Deklaration

IHPDFCustomStreamFilter = interface(IInterface)
  function GetFilterName: AnsiString;
  function GetMode: THPDFCustomStreamFilterMode;
  function GetInputSeekContract: THPDFCustomStreamSeekContract;
  function GetOutputSeekContract: THPDFCustomStreamSeekContract;
  function DecodePush(Input, Output: TStream;
    const Request: THPDFCustomStreamFilterRequest;
    out Diagnostic: AnsiString): Boolean;
  function OpenPullStream(Input: TStream;
    const Request: THPDFCustomStreamFilterRequest;
    out DecodedStream: TStream;
    out Diagnostic: AnsiString): Boolean;
end;

Parametre

Input er lånt til callbacken, Output er en isoleret afgrænset destination for push-tilstand, og Request leverer trinidentitet, resterende budget og annullering

DecodedStream ejes af HotPDF efter et vellykket pull-resultat, mens Diagnostic bør forklare et falsk resultat

Returværdi

Returnér kun True efter oprettelse af et komplet gyldigt trinvist resultat

Bemærkninger om brug

• Kun metoden, der vælges af Mode, kaldes
• Frigiv, behold eller returnér ikke den lånte Input-stream
• Lange handlinger bør samarbejdende kontrollere Request.CancellationToken
• Undtagelser isoleres som dpsCustomFilterError, dpsBudgetExceeded eller dpsCancelled
• Callbacks udføres synkront og uden for registerlåsen

Relaterede API'er

• Register over brugerdefinerede streamfiltre
• THotPDF.RegisterCustomStreamFilter
• THPDFCustomStreamFilterRequest