System.IOUtils.TFile.ReadAllText

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

class function ReadAllText(const Path: string): string; overload; inline; static;
class function ReadAllText(const Path: string;
const Encoding: TEncoding): string; overload; inline; static;

C++

static System::UnicodeString __fastcall ReadAllText(const System::UnicodeString Path)/* overload */;
static System::UnicodeString __fastcall ReadAllText(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding)/* overload */;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
System.IOUtils.pas
System.IOUtils.hpp
System.IOUtils TFile


Beschreibung

Gibt den Inhalt einer Textdatei als String zurück.

ReadAllText liest den Inhalt einer Textdatei und gibt einen String mit dem aus der Datei gelesenen Text zurück.

ReadAllText mit einem Parameter liest zuerst die Präambel-Bytes vom Beginn der Path-Textdatei. Dann überspringt ReadAllText die Präambel-Bytes und liest den Inhalt der Textdatei an diesem Offset. ReadAllText gibt einen String mit dem aus der Datei gelesenen Text zurück.
Wenn die Path-Datei kein BOM (Byte Order Mark) für eine der Standardcodierungen enthält, wird die Standardcodierung Default akzeptiert und die entsprechende Anzahl Bytes wird übersprungen.

ReadAllText mit zwei Parametern liest zuerst ab dem Beginn der Path-Textdatei und überspringt die Anzahl Bytes, die der Präambel des angegebenen Encoding entspricht. Dann liest ReadAllText den Inhalt der Textdatei ab diesem Offset und gibt einen String mit dem aus der Datei gelesenen Text zurück.

ReadAllText hat die folgenden Parameter:

  • Path ist der Pfad zu der Datei.
  • Encoding ist die Codierung des Texts in der Path-Datei.
Notes:
  • Eine Präambel ist eine Sequenz von Bytes, die die verwendete Codierung angibt. Sie wird als Byte Order Mark (BOM) bezeichnet.
  • ReadAllText löst eine Exception aus, wenn die Datei nicht geöffnet werden kann oder der Pfad ungültig ist.
  • Wenn die angegebene Codierung von der tatsächlichen Codierung der Datei abweicht, ist der Rückgabewert undefiniert. In einigen Fällen wird eine EEncondingError-Exception ausgelöst. Wird beispielsweise eine ANSI-Datei mit Akzentbuchstaben als UTF8 geöffnet, wird ein unvorhersehbarer String mit unbrauchbaren Zeichen zurückgegeben oder eine EEncondingError-Exception generiert.

Siehe auch

Codebeispiele