System.IOUtils.TFile
Delphi
TFile = record
C++
struct DECLSPEC_DRECORD TFile
{
private:
class DELPHICLASS TLinesEnumerator;
#ifndef _WIN64
#pragma pack(push,4)
#endif /* not _WIN64 */
class PASCALIMPLEMENTATION TLinesEnumerator : public System::TInterfacedObject
{
typedef System::TInterfacedObject inherited;
private:
System::UnicodeString FPath;
System::Sysutils::TEncoding* FEncoding;
System::Classes::TTextReader* FReader;
System::UnicodeString FLine;
protected:
void __fastcall Reset();
bool __fastcall MoveNext();
System::TObject* __fastcall GetCurrent();
System::UnicodeString __fastcall GetCurrentStr();
System::_di_IEnumerator __fastcall GetEnumerator();
System::DelphiInterface<System::IEnumerator__1<System::UnicodeString> > __fastcall GetEnumeratorStr();
public:
__fastcall TLinesEnumerator(const System::UnicodeString Path, System::Sysutils::TEncoding* Encoding);
__fastcall virtual ~TLinesEnumerator();
private:
void *__IEnumerable__1; // System::IEnumerable__1<System::UnicodeString>
void *__IEnumerator__1; // System::IEnumerator__1<System::UnicodeString>
void *__IEnumerator; // System::IEnumerator
public:
operator System::IEnumerable__1<System::UnicodeString>*(void) { return (System::IEnumerable__1<System::UnicodeString>*)&__IEnumerable__1; }
operator System::IEnumerator__1<System::UnicodeString>*(void) { return (System::IEnumerator__1<System::UnicodeString>*)&__IEnumerator__1; }
operator System::IEnumerator*(void) { return (System::IEnumerator*)&__IEnumerator; }
};
#ifndef _WIN64
#pragma pack(pop)
#endif /* not _WIN64 */
private:
static _DELPHI_CONST System::Int8 FCMinFileNameLen = System::Int8(0xc);
static void __fastcall InternalCheckFilePathParam(const System::UnicodeString Path, const bool FileExistsCheck);
static void __fastcall CheckAppendAllTextParameters(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding, const bool NeedEncoding);
static void __fastcall CheckAppendTextParameters(const System::UnicodeString Path);
static void __fastcall CheckCopyParameters(const System::UnicodeString SourceFileName, const System::UnicodeString DestFileName, const bool Overwrite);
static void __fastcall CheckCreateParameters(const System::UnicodeString Path);
static void __fastcall CheckCreateTextParameters(const System::UnicodeString Path);
static void __fastcall CheckDecryptParameters(const System::UnicodeString Path);
static void __fastcall CheckDeleteParameters(const System::UnicodeString Path);
static void __fastcall CheckEncryptParameters(const System::UnicodeString Path);
static void __fastcall CheckGetAttributesParameters(const System::UnicodeString Path);
static void __fastcall CheckGetCreationTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckGetCreationTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckGetLastAccessTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckGetLastAccessTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckGetLastWriteTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckGetLastWriteTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckMoveParameters(const System::UnicodeString SourceFileName, const System::UnicodeString DestFileName);
static void __fastcall CheckOpenParameters(const System::UnicodeString Path);
static void __fastcall CheckOpenReadParameters(const System::UnicodeString Path);
static void __fastcall CheckOpenTextParameters(const System::UnicodeString Path);
static void __fastcall CheckOpenWriteParameters(const System::UnicodeString Path);
static void __fastcall CheckReadAllBytesParameters(const System::UnicodeString Path);
static void __fastcall CheckReadAllLinesParameters(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding, const bool NeedEncoding);
static void __fastcall CheckReadAllTextParameters(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding, const bool NeedEncoding);
static void __fastcall CheckReplaceParameters(const System::UnicodeString SourceFileName, const System::UnicodeString DestinationFileName, const System::UnicodeString DestinationBackupFileName);
static void __fastcall CheckSetAttributesParameters(const System::UnicodeString Path);
static void __fastcall CheckSetCreationTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckSetCreationTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckSetLastAccessTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckSetLastAccessTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckSetLastWriteTimeParameters(const System::UnicodeString Path);
static void __fastcall CheckSetLastWriteTimeUtcParameters(const System::UnicodeString Path);
static void __fastcall CheckWriteAllBytesParameters(const System::UnicodeString Path);
static void __fastcall CheckWriteAllLinesParameters(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding, const bool NeedEncoding);
static void __fastcall CheckWriteAllTextParameters(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding, const bool NeedEncoding);
static System::Sysutils::TEncoding* __fastcall GetEncoding(System::Classes::TStream* const Stream);
static System::TStringDynArray __fastcall GetStringArrayFromText(const System::UnicodeString Text);
static System::Classes::TStringList* __fastcall GetStringListFromArray(const System::TStringDynArray AnArray);
static System::Classes::TFileStream* __fastcall DoCreateOpenFile(const System::UnicodeString Path);
static bool __fastcall DoCopy(const System::UnicodeString SourceFileName, const System::UnicodeString DestFileName, const bool Overwrite);
static TFileAttributes __fastcall DoGetAttributes(const System::UnicodeString Path, bool FollowLink = true);
static System::Sysutils::TBytes __fastcall DoReadAllBytes(const System::UnicodeString Path);
static System::UnicodeString __fastcall DoReadAllText(const System::UnicodeString Path)/* overload */;
static System::UnicodeString __fastcall DoReadAllText(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding)/* overload */;
static void __fastcall DoSetAttributes(const System::UnicodeString Path, const TFileAttributes Attributes);
static void __fastcall DoWriteAllText(const System::UnicodeString Path, const System::UnicodeString Contents, System::Sysutils::TEncoding* const Encoding, const bool WriteBOM);
static void __fastcall DoWriteAllLines(const System::UnicodeString Path, const System::TStringDynArray Contents, System::Sysutils::TEncoding* const Encoding, const bool WriteBOM);
public:
static TFileAttributes __fastcall IntegerToFileAttributes(const int Attributes);
static int __fastcall FileAttributesToInteger(const TFileAttributes Attributes);
static System::Classes::TFileStream* __fastcall Create(const System::UnicodeString Path)/* overload */;
static System::Classes::TFileStream* __fastcall Create(const System::UnicodeString Path, const int BufferSize)/* overload */;
static void __fastcall AppendAllText(const System::UnicodeString Path, const System::UnicodeString Contents)/* overload */;
static void __fastcall AppendAllText(const System::UnicodeString Path, const System::UnicodeString Contents, System::Sysutils::TEncoding* const Encoding)/* overload */;
static System::Classes::TStreamWriter* __fastcall AppendText(const System::UnicodeString Path);
static void __fastcall Copy(const System::UnicodeString SourceFileName, const System::UnicodeString DestFileName)/* overload */;
static void __fastcall Copy(const System::UnicodeString SourceFileName, const System::UnicodeString DestFileName, const bool Overwrite)/* overload */;
static bool __fastcall CreateSymLink(const System::UnicodeString Link, const System::UnicodeString Target);
static System::Classes::TStreamWriter* __fastcall CreateText(const System::UnicodeString Path);
static void __fastcall Decrypt(const System::UnicodeString Path);
static void __fastcall Delete(const System::UnicodeString Path);
static void __fastcall Encrypt(const System::UnicodeString Path);
static bool __fastcall Exists(const System::UnicodeString Path, bool FollowLink = true);
static __int64 __fastcall GetSize(const System::UnicodeString Path);
static TFileAttributes __fastcall GetAttributes(const System::UnicodeString Path, bool FollowLink = true);
static System::TDateTime __fastcall GetCreationTime(const System::UnicodeString Path);
static System::TDateTime __fastcall GetCreationTimeUtc(const System::UnicodeString Path);
static System::TDateTime __fastcall GetLastAccessTime(const System::UnicodeString Path);
static System::TDateTime __fastcall GetLastAccessTimeUtc(const System::UnicodeString Path);
static System::TDateTime __fastcall GetLastWriteTime(const System::UnicodeString Path);
static System::TDateTime __fastcall GetLastWriteTimeUtc(const System::UnicodeString Path);
static bool __fastcall GetSymLinkTarget(const System::UnicodeString FileName, System::Sysutils::TSymLinkRec &SymLinkRec)/* overload */;
static bool __fastcall GetSymLinkTarget(const System::UnicodeString FileName, System::UnicodeString &TargetName)/* overload */;
static void __fastcall Move(System::UnicodeString SourceFileName, System::UnicodeString DestFileName);
static System::Classes::TFileStream* __fastcall Open(const System::UnicodeString Path, const TFileMode Mode)/* overload */;
static System::Classes::TFileStream* __fastcall Open(const System::UnicodeString Path, const TFileMode Mode, const TFileAccess Access)/* overload */;
static System::Classes::TFileStream* __fastcall Open(const System::UnicodeString Path, const TFileMode Mode, const TFileAccess Access, const TFileShare Share)/* overload */;
static System::Classes::TFileStream* __fastcall OpenRead(const System::UnicodeString Path);
static System::Classes::TStreamReader* __fastcall OpenText(const System::UnicodeString Path);
static System::Classes::TFileStream* __fastcall OpenWrite(const System::UnicodeString Path);
static System::Sysutils::TBytes __fastcall ReadAllBytes(const System::UnicodeString Path);
static System::TStringDynArray __fastcall ReadAllLines(const System::UnicodeString Path)/* overload */;
static System::TStringDynArray __fastcall ReadAllLines(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding)/* overload */;
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 */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetLinesEnumerator(const System::UnicodeString Path)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetLinesEnumerator(const System::UnicodeString Path, System::Sysutils::TEncoding* const Encoding)/* overload */;
static void __fastcall Replace(const System::UnicodeString SourceFileName, const System::UnicodeString DestinationFileName, const System::UnicodeString DestinationBackupFileName)/* overload */;
static void __fastcall Replace(System::UnicodeString SourceFileName, System::UnicodeString DestinationFileName, System::UnicodeString DestinationBackupFileName, const bool IgnoreMetadataErrors)/* overload */;
static void __fastcall SetAttributes(const System::UnicodeString Path, const TFileAttributes Attributes);
static void __fastcall SetCreationTime(const System::UnicodeString Path, const System::TDateTime CreationTime);
static void __fastcall SetCreationTimeUtc(const System::UnicodeString Path, const System::TDateTime CreationTime);
static void __fastcall SetLastAccessTime(const System::UnicodeString Path, const System::TDateTime LastAccessTime);
static void __fastcall SetLastAccessTimeUtc(const System::UnicodeString Path, const System::TDateTime LastAccessTime);
static void __fastcall SetLastWriteTime(const System::UnicodeString Path, const System::TDateTime LastWriteTime);
static void __fastcall SetLastWriteTimeUtc(const System::UnicodeString Path, const System::TDateTime LastWriteTime);
static void __fastcall WriteAllBytes(const System::UnicodeString Path, const System::Sysutils::TBytes Bytes);
static void __fastcall WriteAllLines(const System::UnicodeString Path, const System::TStringDynArray Contents)/* overload */;
static void __fastcall WriteAllLines(const System::UnicodeString Path, const System::TStringDynArray Contents, System::Sysutils::TEncoding* const Encoding)/* overload */;
static void __fastcall WriteAllText(const System::UnicodeString Path, const System::UnicodeString Contents)/* overload */;
static void __fastcall WriteAllText(const System::UnicodeString Path, const System::UnicodeString Contents, System::Sysutils::TEncoding* const Encoding)/* overload */;
};
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
record struct |
public | System.IOUtils.pas System.IOUtils.hpp |
System.IOUtils | System.IOUtils |
Description
Contains a large number of static utility methods used in file manipulations.
TFile is a record containing only static methods used to perform various operations on files. Do not declare variables of type TFile, since TFile has no instance methods or fields. Operations that can be carried out using TFile include:
- Creating, renaming, and deleting files
- Simplified access to file contents
- Manipulating file attributes and timestamps
Note: Most of the methods exposed by TFile are signature-compatible with the ones exposed by the File class in the .NET Framework.