TPDFlibLogger

Gegevenstypen, documentbeheer

Beschrijving

TPDFlibLogger is de gestructureerde loggerklasse die via zijn Logger-eigenschap aan een TPDFlib-instantie hangt. Wanneer toegewezen, ontvangt hij Debug-, Info-, Warn- en Error-records, elk met een numerieke code uit de bestaande LastErrorCode-taxonomie en een voor mensen leesbare melding De logger is in eigendom van de aanroeper en kan over meerdere worden gedeeld

TPDFlib-instanties. Hij staat standaard op nil, dus het pad zonder logger kost niets

Syntaxis

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;

Parameters

LevelDe minimale ernst om uit te geven; records onder deze drempel worden geruisloos weggegooid
OnLogEen host-callback die voor elke uitgegeven record wordt aangeroepen en het niveau, de code en de melding ontvangt
FileNameIndien gezet worden records ook naar dit bestand geschreven via een thread-safe TStreamWriter-sink; maak hem leeg om bestandslogging te stoppen

Opmerkingen

De handigheidsmethodes Debug, Info, Warn en Error_ roepen Log aan met het bijbehorende niveau

Bestandsschrijvingen worden geserialiseerd met een kritieke sectie, dus één loggerinstantie is veilig te gebruiken vanuit workerthreads

PDFlibErrorMessage(Code) vertaalt een numerieke code naar een mensenbericht en kan onafhankelijk van de logger worden aangeroepen

Zie ook

Logger, OnOperationProgress, LastErrorCode