Motivation

Das im folgenden beschriebene Projekt bietet die komfortable Möglichkeit, Ausgaben eines Programms in ein separates Fenster zu machen und dort zu analysieren.

 

Download

VS 2015 Projekt

Binary

Prinzip

Ein .NET-Applikation bindet UrsLoggingLib ein und ruft dessen Methoden zur Anzeige von Logging-Daten auf. Der erste Aufruf einer Methode aus UrsLoggingLib bewirkt, dass einen Instanz von UrsLoggingDisplay gestartet wird. UrsLoggingDisplay erstellt eine NamedPipe über die Logging-Daten übertragen werden können. UrsLoggingLib verbindet sich mit dieser Pipe und sendet über diese die entsprechenden Daten.

Für native C/C++-Programme gibt es eine Wrapper-DLL, die die wichtigsten Methoden für diese Programmtypen zugänglich macht.

Verwendung

Bedienung

 

Logging-Fenster

Das Hauptelement sind das Logging-Fenster. Hier werden die Logging-Einträge gelistet. Welche Einträge angezeigt werden sollen, kann über den Nachrichtenfilter eingestellt werden. Das Logging-Fenster besitzt ein Kontext-Menü mit dem man Inhalte auswählen und in die Zwischenablage kopieren kann.

Wählt man "Text Kopieren", nur der Text der Nachrichten kopiert (rechte Spalte). "Alles kopieren" kopiert auch den Timestamp und den Nachrichtentyp. Die einzelnem Spalten werden durch ein Tabstop-Zeichen getrennt.

Nachrichtenfilter

Über das anhaken der entsprechenden CheckBoxes kann ausgewählt werden, welche Nachrichtentypen (mittlere Spaste angezeigt werden. Standardmäßig besitzt der Filter die Einträge "Intern/Undef.", "Nachricht", "Warnung" und "Fehler". Bei Bedarf lässt er sich über das API konfigurieren.

Konsolen-Fenster

Im Konsolen-Fenster wird Fließtext angezeigt. Es dient zur Ausgabe von unstrukturierten Informationen.

Schriftauswahl

Hier lässt sich die zur Anzeige benutzte Schrift einstellen.

Verbindungsanzeige

Hier wird angezeigt, ob eine Verbindung zu einem Client besteht. Werden Daten empfangen, wechselt das Symbol für kurze Zeit die Farbe von Blau auf Rot.

.NET API

UrsLoggingLib enthält als Kernelement das Modul UrsLogging, dass sämtliche öffentlichen Methoden bereit stellt. Die Implementierung als Modul bewirkt, dass sämtliche Methoden ohne die Angabe eines Klassennamens aufgerufen werden können.

Initialisierung

Die Methode UrsInitLogging erlaubt es, Einfluss auf die Art und Weise zu nehmen, wie eine Instanz von UrsLoggingDisplay geöffnet wird. Wird diese Funktion nicht verwandt, wird UrsLoggingDisplay beim ersten Aufruf einer anderen Methode mit Standardeinstellungen initialisiert.

UrsInitLogging besitzt zwei optionale Parameter:

• WidowTitle: Gibt den Fenstertitel für UrsLoggingDisplay vor. Wird dieser Parameter nicht angegeben, wird "Urs Logging" und der Erstellungszeitpunkt von UrsLoggingDisplay angezeigt. Der Standardwert ist "".
• UseSameWindow: Es wird versucht, immer mit der gleichen Instanz von UrsLoggingDisplay zu arbeiten. Der Standardwert ist False.
  Insbesondere dann, wenn das zu loggende häufiger gestartet wird, mehren sich die geöffneten Instanzen. Wird immer das gleiche Ausgabefenster genutzt,  empfiehlt es sich, anschließend die Methode UrsClearLog (s.u.) aufzurufen.
  Hinweis: Es kann nur einen geben. Normalerweise wird für den Namen der Pipe ein Zufallswert (GUID) gewählt. Wird jedoch UseSameWindow angegeben, ist der Pipe-Name "UrsLoggingPipe". D.h. alle Applikationen mit UseSameWindow nutzen die die gleiche Instanz von UrsLoggingDisplay.

UrsLoggingDisplay zeigt nach dem Verbindungsaufbau die Nachricht "Client connected" an und die Verbindungsanzeige wechselt auf blau .

Zu Erwähnen wäre an dieser Stelle die Eigenschaft ThrowConnectExecptions. Wenn diese den Wert True hat, wird eine Exception geworfen, wenn keine Verbindung zu der Pipe aufgebaut werden kann. Dieses Problem sollte normalerweise nicht auftreten, deshalb ist der Standardwert hier True. Wenn es Probleme mit der Bearbeitung von Exceptions gibt, sollte diese Eigenschaft vor Aufruf von UrsInitLogging auf False gesetzt werden.

 

 

Methoden

Logging

Zur Ausgabe von Logging-Nachrichten stehen folgende Methoden zur Verfügung:

• UrsWriteLogItem(MsgType As Byte, Msg As String): Gibt eine Nachricht im Logging-Fenster aus. Nachrichtentypen, die nicht durch Filterwerte abgedeckt sind werden durch 0 ersetz. Im Standard stehen die Type 1 ( = Nachricht) .. 3 ( = Fehler) zur Verfügung.
• UrsWriteConsole(Text As String): Gibt eine Nachricht im Konsolenfenster aus. Struktur-Informationen –wie Zeilenvorschübe, etc.– müssen explizit angegeben werden.
• UrsClearLog(ClearConsole As Boolean): Löscht die Inhalte des Logging-Fensters. Über den optionalen Parameter ClearConsole kann festgelegt werden, ob das Konsolen-Fenster ebenfalls gelöscht werden soll. Der Standardwert ist False.

Konfiguration

Aktuell kann nur der Nachrichtenfilter konfiguriert werden.

• UrsClearMsgTypeFilter: Löscht den aktuellen Nachrichtenfilter. Der Filterwert 0 ( = Intern/Undef.) wird nicht gelöscht.
• UrsAddMsgTypeFilter(Name As String, checked As Boolean). Name gibt die Bezeichnung des Nachrichtentyps an. checked legt initial fest, ob der Filterwert angehakt ist oder nicht. Die numerischen Werte Nachrichtentype werden fortlaufend vergeben.

C/C++ API

Im C/C++ API (UrsLoggingC) sind folgende Funktionen über eine Wrapper-Klasse auf die entsprechenden Methoden des .NET API abgebildet:

_declspec(dllexport) void UrsWriteLogItem (int MsgType, const char* charstrMsg);
_declspec(dllexport) void UrsWriteConsole(const char* charstrMsg);

Test-Programm

Das Projekt enthält auch zwei kleine Testprogramme.

.NET Testprogramm

Ein kleines Programm (UrsLoggingTestApp) erlaubt es, alle Funktionen anzusprechen.

C Testprogramm

Zum Testen der C-Schnittstelle dient das Konsolenprogramm UrsLoggingTestAppC.