System.IOUtils.TFile.ReadAllText
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 */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | System.IOUtils.pas System.IOUtils.hpp |
System.IOUtils | TFile |
説明
テキスト ファイルの内容を文字列として返します。
ReadAllText は、テキスト ファイルの内容を読み込み、ファイルから読み込んだテキストを格納した文字列を返します。
1 のパラメータを持つ ReadAllText は、まず Path
テキスト ファイルの最初からプリアンブル バイトを読み込みます。そして、ReadAllText は、プリアンブル バイトをスキップし、このオフセットから始まるテキスト ファイルのコンテンツを読み込みます。
ReadAllText は、ファイルから読み込んだテキストを格納する文字列を返します。
Path
ファイルが、標準エンコーディングのいずれかのバイト順マークを含んでいない場合、Default 標準エンコーディングが選択され、それに相当する数のバイトがスキップされます。
2 つのパラメータを持つ ReadAllText は、まず Path
テキスト ファイルの最初から読み込み、指定された Encoding
のプリアンブルに相当するバイト数がスキップされます。そして、ReadAllText は、このオフセットから始まるテキスト ファイルの内容を読み込み、ファイルから読み込んだテキストを格納した文字列を返します。
ReadAllText には、次のパラメータがあります:
Path
は、ファイルへのパスです。Encoding
は、Path
ファイル内に格納されているテキストのエンコーディングです。
Notes:
- プリアンブル部は、使用されるエンコーディングを指定するバイトのシーケンスです。これは、バイト順マーク(BOM)と呼ばれます。
- ReadAllText は、ファイルを開くことができない、またはパスが不正である場合に例外を発生させます。
- 指定されたエンコーディングが、ファイルの実際のエンコーディングと異なる場合、戻り値は未定義となります。場合により、EEncondingError 例外が発生します。たとえば、
ANSI
ファイルを、UTF8 のアクセント文字と共に開くと、文字化けした予期しない文字列が返されたり、EEncondingError 例外が発生します。
関連項目
- System.SysUtils.TEncoding.GetBufferEncoding
- System.IOUtils.TFile.ReadAllBytes
- System.IOUtils.TFile.ReadAllLines