Code-Beispiel

Schreiben einer Protokolldatei

Ein Beispiel zum Einsatz der Klasse System.IO.FileStream, StreamWriter aus der .NET-Klassenbibliothek.

Autor: Dr. Holger Schwichtenberg

Beschreibung

Die Verwendung von Streams (Datenströmen) ist ein zentrales Konzept in .NET. Ein Stream ist eine beliebige Byte-Folge in einem beliebigen Medium, z.B. eine Textdatei, eine Binärdatei, ein Datenstrom im Netzwerk oder auch eine Byte-Folge im Speicher. Es gibt für Streams in der FCL eine abstrakte Basisklasse System.IO.Stream, von der zahlreiche Klassen in verschiedenen Namespaces erben. Es gibt zahlreiche Attribute und Methoden in FCL-Klassen, die mit Streams arbeiten.

Auf einen Stream greift man mit Hilfe anderer Klassen zu: StreamReader und StreamWriter für Streams mit ASCII-Zeichen und BinaryReader und BinaryWriter für Streams mit beliebigen Byte-Folgen. StreamReader und StreamWriter sind Unterklassen der Klassen TextReader bzw. TextWriter. BinaryReader und BinaryWriter sind dagegen direkt von System.Object abgeleitet.

Während ein FileInfo-Objekt das Äußere einer Datei darstellt, ist ein FileStream-Objekt der Inhalt einer Datei.

Das grundsätzliche Vorgehen beim Schreiben in eine Datei ist:
  • Erzeugen eines FileStream-Objekts unter Angabe der Parameter FileMode und FileAccess
  • Erzeugen eines StreamWriter-Objekts auf Basis des FileStream-Objekts
  • Setzen des Zeigers auf Anfang oder Ende des Streams
  • Danach können Inhalte mit Write() und WriteLine() geschrieben werden.
  • Aufruf von Close() im StreamWriter-Objekt
  • Aufruf von Close() im FileStream-Objekt

Ohne Aufruf von Close() im StreamWriter wird nichts in die Datei geschrieben. Close() darf für den FileStream erst nach dem Schließen des StreamWriter-Objekts aufgerufen werden.

Für FileAccess und FileMode gibt es Enumerationen in System.IO.
Symbolische Konstante Wenn Datei vorhanden Wenn Datei nicht vorhanden
Append Anhängen Wird erzeugt
Create Wird überschrieben Wird erzeugt
CreateNew Fehler Wird erzeugt
Open Öffnen Fehler
OpenOrCreate Öffnen Wird erzeugt
Truncate Öffnen + Löschen Fehler

Symbolische Konstante Lesen Schreiben
Read Ja Nein
ReadWrite Ja Ja
Write Nein Ja

Beispiel
Die folgende Routine hängt eine Protokollierungsinformation an eine Textdatei an.

Programmcodebeispiele Visual Basic .NET (VB.NET)

' ============================
' .NET-Code-Beispiel in Visual Basic .NET
' Schreiben einer Protokolldatei
' (C) Holger@Schwichtenberg.de
' ============================
Public Sub datei_schreiben()
Const DATEINAME As String = _
"d:\buch\dateisystem\protokoll.txt"

' --- Datei öffnen
Dim fs As FileStream = New FileStream( _
DATEINAME, FileMode.OpenOrCreate, _
FileAccess.Write)

' --- Stream öffnen
Dim w As StreamWriter = New StreamWriter(fs)
' --- Anfügen am Ende
w.BaseStream.Seek(0, SeekOrigin.End)
' --- Zeilen schreiben
w.WriteLine("Start des Programms: " & now)
' --- Einzelne Zeichen schreiben
Dim a As Integer
For a = 1 To 26
w.Write(chr(96 + a))
Next
w.WriteLine()
' --- Zeilen schreiben
w.WriteLine("Ende des Programms: " & now)
' --- Writer und Stream schließen
w.Close()
fs.Close()
End Sub

Programmcodebeispiele CSharp (C#)

using System;
using System.IO;

namespace FCLBuch._SystemIO {

public class Samples_Dateiinhalte {

// Schreiben einer Protokolldatei
public void Datei_Schreiben() {

string dateiName = @"..\_daten\dateisystem\protokoll.txt";
// Datei öffnen
FileStream fs = new FileStream(dateiName, FileMode.OpenOrCreate, FileAccess.Write);
// Stream öffnen
StreamWriter w = new StreamWriter(fs);
// Anfügen am Ende
w.BaseStream.Seek(0, SeekOrigin.End);
// Zeilen Schreiben
w.WriteLine("Start des Programms: " + DateTime.Now.ToString());
// Einzelne Zeichen schreiben

for ( int i=0; i<26; i++ )
w.Write((char)(97 + i));

w.WriteLine();
// Zeilen Schreiben
w.WriteLine("Ende des Programms: " + DateTime.Now.ToString());
// Writer und Stream schließen
w.Close();
fs.Close();

}
}
}

 

Querverweise

 Liste aller Codebeispiele  Definition '.NET Framework Class Library'  Verfügbarkeit der Klasse 'System.IO.FileStream, StreamWriter'  Übersicht über den FCL-Namensraum 'System.IO'  .NET & Visual Studio Community Portal

Buchtipp

Buchcover PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch (5. Auflage Oktober 2022 (9. Auflage Gesamtreihe)) PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch
Autoren: Dr. Holger Schwichtenberg
erschienen 10/2022, 1426 Seiten
ISBN: 3446472967

Beratung & Support

Schulungen zu diesem Thema

 Visual Basic .NET - Aufbauwissen
 Grundlagen der objektorientierten Programmierung anhand von C# oder Visual Basic .NET
 Unit Testing / Testgetriebene Entwicklung / Test Driven Development (TDD) von .NET-Anwendungen (C# oder Visual Basic .NET)
 Visual Basic 6.0 (VB6.0)
 Objektorientierte Entwurfsmuster (Design-Pattern/Architektur-Pattern) mit .NET (C#, Visual Basic .NET)
 Visual Basic .NET - Basiswissen
 Windows Modern Apps/Windows Universal Apps entwickeln mit der Windows Runtime (WinRT), XAML und .NET/C#/Visual Basic
 Visual Basic Script (VBScript/VBS) - Sprachsyntax und Praxiseinsatz
 Word-Programmierung mit Visual Basic for Applications (VBA)
 Visual Studio Tools for Microsoft Office (VSTO) - Microsoft Office-Programmierung mit .NET und C# oder Visual Basic in Visual Studio
 Multi-Threading in .NET mit C#/Visual Basic .NET und/oder C++ und C++/CLI
 C# für Umsteiger von Visual Basic .NET
 Objektorientierte Programmierung (OOP) mit C#, Java, C++, Visual Basic.NET o.ä.
 Excel-Programmierung mit Visual Basic for Applications (VBA)
 Visual Basic .NET für Umsteiger von VBA/VB 4/5/6
 Visual Basic 2005 (Visual Basic 8.0)
 .NET und C# für Umsteiger von klassischem Visual Basic/COM
 Outlook-Programmierung mit Visual Basic for Applications (VBA)
 Das Component Object Model - für Script- und Visual Basic-Entwickler
 C#-Basiswissen (Grundlagen der Programmiersprache C#)
 .NET Akademie: Unit Testing und Test Driven Development (TDD) mit .NET/C# (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 7.0/7.1/7.2/7.3
 Task Parallel Library (TPL) - Parallelprogrammierung/Multi-Threading in .NET/C#
 Event Driven Design (mit .NET/C# oder Java)
 Neuerung in der CLR 2.0 und C# 2005
 Neuerungen in C# 6.0
 .NET Akademie: Blazor-Hands-On: Echte Single-Page-Web-Apps mit .NET und C# entwickeln (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 3.0 (Visual C# 2008)
 Refactoring von Programmcode in C, C++, C#, Java, Kotlin, JavaScript, TypeScript, Python, Go oder Rust
 Windows 8/Windows 8.1 für Entwickler: Programmierung mit der Windows Runtime (WinRT) - Erstellen von Windows Apps mit C#/XAML und/oder JavaScript/HTML
 Anfrage für eine individuelle Schulung zum Thema Visual Basic C#  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema

  Blazor 8.0: Moderne Webanwendungen und hybride Cross-Platform-Apps mit .NET 8.0, C# 12.0 und Visual Studio 2022
  C# 12.0 Crashkurs
  C# 11.0 Crashkurs
  C# 10.0 Crashkurs
  C# 9.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET 5.0, .NET Core und Xamarin
  ASP.NET Core Blazor 3.1/3.2: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
  C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
  Windows Store Apps entwickeln mit C# und XAML - Crashkurs
  Microsoft ASP.NET 4.0 mit C# 2010 - Entwicklerbuch
  Microsoft Viusal C# 2010
  Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
  ASP.NET 4.0 mit Visual C# 2010
  Visual Basic 2010
  Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Entwicklerbuch
 Alle unsere aktuellen Fachbücher  E-Book-Abo für ab 99 Euro im Jahr