TPDFlibLogger

Types de données, gestion de documents

Description

TPDFlibLogger est la classe de journalisation structurée attachée à une instance TPDFlib par sa propriété Logger. Lorsqu’elle est affectée, elle reçoit des enregistrements Debug, Info, Warn et Error, chacun avec un code numérique issu de la taxonomie LastErrorCode et un message lisible

Le journaliseur appartient à l'appelant et peut être partagé entre plusieurs instances TPDFlib. Il vaut nil par défaut, sans coût en son absence

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;

Paramètres

LevelLa gravité minimale à émettre ; les enregistrements inférieurs à ce seuil sont ignorés silencieusement
OnLogUn rappel hôte invoqué pour chaque enregistrement émis et recevant le niveau, le code et le message
FileNameLorsqu'il est défini, les enregistrements sont également écrits dans ce fichier au moyen d'un récepteur TStreamWriter sûr pour les threads ; effacez-le pour arrêter la journalisation dans le fichier

Remarques

Les méthodes pratiques Debug, Info, Warn et Error_ appellent Log avec le niveau correspondant

Les écritures de fichier sont sérialisées par une section critique, de sorte qu'une seule instance de journalisation peut être utilisée en toute sécurité depuis des threads de travail

PDFlibErrorMessage(Code) traduit un code numérique en message lisible et peut être appelé indépendamment du journaliseur

Voir aussi

Logger, OnOperationProgress, LastErrorCode