n2pdf verfügt über die Funktion zur Datenprotokollierung, um diese im Rahmen der Auswertung von Konvertierungen zu nutzen. Die gelieferten Daten können anschließend von Administratoren oder Entwicklern genutzt werden, um bei der Beseitigung von Problemen zu unterstützen.
Die Aktivierung erfolgt über die Funktion N2PDFSetGlobalOption mit der globalen Option N2PDFGLOBALOPTION_LOG_ENABLED. Alle auftretenden Fehler oder Information werden dabei, aufgrund ihrer Wichtigkeit, in verschiedene Kategorien eingeteilt. Sie haben hierdurch die Kontrolle, bis zu welchem Level Nachrichten aufgezeichnet werden sollen. Die Steuerung dieses Levels erfolgt über die Option N2PDFGLOBALOPTION_LOG_LEVEL, mit Angabe der gewünschten Level-Grenze.
Die Einstellung für die Aktivierung des Logging und des Log-Levels wird über die Funktion N2PDFSetGlobalOption gemacht. Nachfolgend die einzelnen Optionen für die Datenprotokollierung. Die einzelnen Werte werden dann über <OptionID> und <OptionStr> der Funktion N2PDFSetGlobalOption bestimmt.
N2PDFGLOBALOPTION_LOG_ENABLED
Mit dieser Option wird die Erstellung der Datenprotokollierung aktiviert.
N2PDFVALUE_TRUE |
Aktivierung der Datenprotokollierung |
N2PDFVALUE_FALSE |
Deaktivierung der Datenprotokollierung |
Beispiel: Aktivierung der Datenprotokollierung
Call N2PDFSetGlobalOption ( N2PDFGLOBALOPTION_LOG_ENABLED, N2PDFVALUE_TRUE, "" )
|
Möchten Sie die Protokollierung der Konvertierung erst in einem bestimmten Abschnitt starten, können Sie, alternativ zur globalen Option, diese auch erst mit dem Aufruf N2PDFInit aktivieren.
JobID = N2PDFInit ( N2PDFVALUE_INIT_USE_LOG ) |
Speicherung der Log-Datei
Um alle gesammelten Informationen zu speichern, müssen Sie im Aufruf von N2PDFProcess diesen Vorgang aktivieren. Dies erfolgt über den Parameter N2PDFVALUE_PROCESS_SAVE_LOG. Durch Setzen des Wertes erzeugt n2pdf neben der zu erstellenden PDF-Datei eine gleichnamige XML-Datei im gleichen Verzeichnis.
Beispiel: Aktivierung der Speicherung aller gesammelten Daten
Call N2PDFProcess ( JobID, PDFFileName, N2PDFVALUE_PROCESS_SAVE_LOG )
N2PDFGLOBALOPTION_LOG_LEVEL
Der Umfang, der in der Protokolldatei geschrieben wird, richtet sich nach dem gesetzten Log-Level. Wenn Sie einen Log-Level setzen, werden alle Nachrichten in dem Log aufgenommen die diesem Level gleich sind oder ihn überschreiten.
Die Reihenfolge (vom niedrigsten zum höchsten) der Log-Level:
ALL > TRACE > DEBUG > INFO > WARNING > ERROR > FATAL > OFF
Name |
Level |
Inhalt |
ALL |
0 |
Ungefilterte Ausgabe aller Meldungen |
TRACE |
1 |
Ausgabe von ausführlichen Debug-Informationen |
DEBUG |
2 |
Allgemeine Debug-Informationen (zur Fehlersuche) |
INFO |
3 |
Allgemeine Informationen (z. B. Programmstart/-ende, Verarbeitungsdauer) |
WARNING |
4 |
Aufgetretene, unerwartende aber nicht kritische Probleme (z. B. fehlende CD-Records) |
ERROR |
5 |
Fehler die abgefangen wurden, eine Fortführung kann möglich sein |
FATAL |
6 |
Kritischer Fehler mit Abbruch der Anwendung |
OFF |
7 |
Keine Ausgabe von Logging-Informationen, Deaktivierung |
Beispiel: Setzen des Log-Levels "ALL" (0) zur ungefilterten Ausgabe aller Meldungen
Call N2PDFSetGlobalOption ( N2PDFGLOBALOPTION_LOG_LEVEL, "0", "" )
Beispiel: Setzen des Log-Levels "WARNING" (4) zur Ausgabe von Meldungen der Stufe "Warning", "Error" oder "Fatal"
Call N2PDFSetGlobalOption ( N2PDFGLOBALOPTION_LOG_LEVEL, "4", "" )
Datenprotokollierung über n2pdf.ini
Zusätzlich zur skriptgesteuerten Aktivierung der Datenprotokollierung, können Sie die Protokollierung auch über einen Eintrag in der n2pdf.ini aktivieren.
[Setup]
LogEnabled=1
LogLevel=5
Die Optionen LogEnabled und LogLevel erlauben eine Aktivierung und das Setzen eines bestimmten Levels zur globalen Datenprotokollierung. Eine Speicherung des Logs über N2PDFProcess ist weiterhin notwendig.