TPDFlibLogger

Datové typy, správa dokumentů

Popis

TPDFlibLogger je strukturovaná logger třída připojená k instanci TPDFlib prostřednictvím její vlastnosti Logger. Když je přiřazena, přijímá záznamy Debug, Info, Warn a Error, každý s číselným kódem ze stávající taxonomie LastErrorCode a zprávou srozumitelnou člověku

Logger je ve vlastnictví volajícího a může se sdílet napříč několika instancemi TPDFlib. Jako výchozí je nil, takže cesta bez loggeru je bez nákladů

Syntaxe

Delphi

TPDFlibLogger = Class
  Public
    Constructor Create; Virtual;
    Destructor Destroy; Override;
    Procedure Log(Level: TPDFlibLogLevel; Code: Integer; Const Msg: WideString); Overload;
    Procedure Log(Level: TPDFlibLogLevel; Code: Integer; Const Msg: WideString;
      Const ExtraFieldsText: WideString); Overload;
    Procedure Debug(Code: Integer; Const Msg: WideString);
    Procedure Info(Code: Integer; Const Msg: WideString);
    Procedure Warn(Code: Integer; Const Msg: WideString);
    Procedure Error_(Code: Integer; Const Msg: WideString);
    Property Level: TPDFlibLogLevel Read FLevel Write FLevel;
    Property OnLog: TPDFlibLogEvent Read FOnLog Write FOnLog;
    Property FileName: WideString Read FFileName Write SetFileName;
  End;

Parametry

LevelMinimální závažnost k vypsání; záznamy pod tímto prahem se mlčky zahodí
OnLogCallback volaný hostitelskou aplikací pro každý zapsaný záznam; předává se v něm úroveň, kód a zpráva
FileNameKdyž je nastaveno, záznamy se navíc zapisují do tohoto souboru přes thread-safe sink TStreamWriter; vymažte ho, abyste zastavili logování do souboru

Poznámky

Pohodlné metody Debug, Info, Warn a Error_ volají Log s odpovídající úrovní

Zápisy do souborů se serializují kritickou sekcí, takže jedna instance loggeru je bezpečná pro použití z pracovních vláken

PDFlibErrorMessage(Code) překládá číselný kód na zprávu srozumitelnou člověku a lze jej volat nezávisle na loggeru

Viz také

Logger, OnOperationProgress, LastErrorCode