QFile Class

Dokumentation der Mitgliedsfunktionen

QFile::QFile()

Konstruiert ein QFile-Objekt.

[explicit] QFile::QFile(QObject *parent)

Konstruiert ein neues Dateiobjekt mit der angegebenen parent.

QFile::QFile(const QString &name)

Konstruiert ein neues File-Objekt, um die Datei mit der angegebenen name zu repräsentieren.

[since 6.0] QFile::QFile(const std::filesystem::path &name)

Konstruiert ein neues File-Objekt, um die Datei mit der angegebenen name zu repräsentieren.

Diese Funktion wurde in Qt 6.0 eingeführt.

QFile::QFile(const QString &name, QObject *parent)

Konstruiert ein neues Dateiobjekt mit dem angegebenen parent, um die Datei mit dem angegebenen name zu repräsentieren.

[since 6.0] QFile::QFile(const std::filesystem::path &name, QObject *parent)

Konstruiert ein neues Dateiobjekt mit der angegebenen parent, um die Datei mit der angegebenen name zu repräsentieren.

Diese Funktion wurde in Qt 6.0 eingeführt.

[virtual noexcept] QFile::~QFile()

Zerstört das Dateiobjekt und schließt es, falls erforderlich.

bool QFile::copy(const QString &newName)

Kopiert die Datei mit dem Namen fileName() nach newName.

Diese Datei wird geschlossen, bevor sie kopiert wird.

Handelt es sich bei der kopierten Datei um einen symbolischen Link (Symlink), wird die Datei kopiert, auf die er verweist, nicht der Link selbst. Mit Ausnahme der Berechtigungen, die kopiert werden, werden keine anderen Metadaten der Datei kopiert.

Gibt bei Erfolg true zurück, andernfalls false.

Beachten Sie, dass copy() false zurückgibt, wenn eine Datei mit dem Namen newName bereits existiert. Das bedeutet, dass QFile nicht überschrieben wird.

Siehe auch setFileName().

[since 6.0] bool QFile::copy(const std::filesystem::path &newName)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

[static] bool QFile::copy(const QString &fileName, const QString &newName)

Dies ist eine überladene Funktion.

Kopiert die Datei mit dem Namen fileName nach newName.

Diese Datei wird geschlossen, bevor sie kopiert wird.

Wenn die kopierte Datei ein symbolischer Link (Symlink) ist, wird die Datei kopiert, auf die er verweist, nicht der Link selbst. Mit Ausnahme der Berechtigungen, die kopiert werden, werden keine anderen Metadaten der Datei kopiert.

Gibt bei Erfolg true zurück, andernfalls false.

Beachten Sie, dass copy() false zurückgibt, wenn eine Datei mit dem Namen newName bereits existiert. Das bedeutet, dass QFile nicht überschrieben wird.

Siehe auch rename().

[static] QString QFile::decodeName(const QByteArray &localFileName)

Dies macht die Umkehrung von QFile::encodeName() mit localFileName.

Siehe auch encodeName().

[static] QString QFile::decodeName(const char *localFileName)

Dies ist eine überladene Funktion.

Gibt die Unicode-Version des angegebenen localFileName zurück. Siehe encodeName() für Details.

[static] QByteArray QFile::encodeName(const QString &fileName)

Konvertiert fileName in eine 8-Bit-Kodierung, die Sie in nativen APIs verwenden können. Unter Windows ist die Kodierung diejenige der aktiven Windows-Codepage (ANSI). Auf anderen Plattformen ist dies UTF-8, für macOS in dekomponierter Form (NFD).

Siehe auch decodeName().

[static] bool QFile::exists(const QString &fileName)

Gibt true zurück, wenn die durch fileName angegebene Datei existiert; andernfalls wird false zurückgegeben.

bool QFile::exists() const

Dies ist eine überladene Funktion.

Gibt true zurück, wenn die durch fileName() angegebene Datei existiert; andernfalls gibt sie false zurück.

Siehe auch fileName() und setFileName().

[override virtual] QString QFile::fileName() const

Reimplements: QFileDevice::fileName() const.

Gibt den Namen zurück, der durch setFileName() oder die QFile Konstruktoren gesetzt wurde.

Siehe auch setFileName() und QFileInfo::fileName().

[since 6.0] std::filesystem::path QFile::filesystemFileName() const

Gibt fileName() als std::filesystem::path zurück.

Diese Funktion wurde in Qt 6.0 eingeführt.

[since 6.3] std::filesystem::path QFile::filesystemSymLinkTarget() const

Gibt symLinkTarget() als std::filesystem::path zurück.

Diese Funktion wurde in Qt 6.3 eingeführt.

[static, since 6.3] std::filesystem::path QFile::filesystemSymLinkTarget(const std::filesystem::path &fileName)

Gibt symLinkTarget() als std::filesystem::path von fileName zurück.

Diese Funktion wurde in Qt 6.3 eingeführt.

bool QFile::link(const QString &linkName)

Erzeugt einen Link mit dem Namen linkName, der auf die Datei verweist, die gerade durch fileName() angegeben wird. Was ein Link ist, hängt vom zugrunde liegenden Dateisystem ab (sei es eine Verknüpfung unter Windows oder ein symbolischer Link unter Unix). Gibt bei Erfolg true zurück, andernfalls false.

Diese Funktion überschreibt keine bereits vorhandene Entität im Dateisystem; in diesem Fall gibt link() false zurück und setzt error() auf RenameError.

Siehe auch setFileName().

[since 6.0] bool QFile::link(const std::filesystem::path &newName)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

[static] bool QFile::link(const QString &fileName, const QString &linkName)

Dies ist eine überladene Funktion.

Erzeugt einen Link mit dem Namen linkName, der auf die Datei fileName zeigt. Was ein Link ist, hängt vom zugrunde liegenden Dateisystem ab (sei es eine Verknüpfung unter Windows oder ein symbolischer Link unter Unix). Gibt bei Erfolg true zurück, andernfalls false.

Siehe auch link().

bool QFile::moveToTrash()

Verschiebt die durch fileName() angegebene Datei in den Papierkorb. Gibt bei Erfolg true zurück und setzt fileName() auf den Pfad, unter dem die Datei im Papierkorb zu finden ist; andernfalls wird false zurückgegeben.

Die Zeit für die Ausführung dieser Funktion ist unabhängig von der Größe der zu löschenden Datei. Wenn diese Funktion für ein Verzeichnis aufgerufen wird, kann sie proportional zur Anzahl der zu löschenden Dateien sein. Wenn die aktuelle fileName() auf einen symbolischen Link zeigt, wird diese Funktion den Link in den Papierkorb verschieben und ihn möglicherweise zerstören, nicht das Ziel des Links.

Diese Funktion verwendet die Windows- und macOS-APIs, um den Löschvorgang auf diesen beiden Betriebssystemen durchzuführen. Auf anderen Systemen (Unix-Systemen) implementiert diese Funktion die FreeDesktop.org Trash-Spezifikation Version 1.0.

[static] bool QFile::moveToTrash(const QString &fileName, QString *pathInTrash = nullptr)

Dies ist eine überladene Funktion.

Verschiebt die durch fileName angegebene Datei in den Papierkorb. Gibt bei Erfolg true zurück und setzt pathInTrash (falls angegeben) auf den Pfad, unter dem die Datei im Papierkorb gefunden werden kann; andernfalls gibt sie false zurück.

Die Zeit für die Ausführung dieser Funktion ist unabhängig von der Größe der zu löschenden Datei. Wenn diese Funktion für ein Verzeichnis aufgerufen wird, kann sie proportional zur Anzahl der zu löschenden Dateien sein. Wenn die aktuelle fileName() auf einen symbolischen Link zeigt, wird diese Funktion den Link in den Papierkorb verschieben und ihn möglicherweise zerstören, nicht das Ziel des Links.

Diese Funktion verwendet die Windows- und macOS-APIs, um den Löschvorgang auf diesen beiden Betriebssystemen durchzuführen. In anderen Fällen (Unix-Systeme) implementiert diese Funktion die FreeDesktop.org Trash-Spezifikation Version 1.0.

[override virtual] bool QFile::open(QIODeviceBase::OpenMode mode)

Reimplements: QIODevice::open(QIODeviceBase::OpenMode mode).

Öffnet die Datei mit den Flags mode und gibt bei Erfolg true zurück, andernfalls false.

Die Flags für mode müssen QIODeviceBase::ReadOnly, WriteOnly oder ReadWrite enthalten. Sie können auch zusätzliche Flags wie Text und Unbuffered enthalten.

Siehe auch QT_USE_NODISCARD_FILE_OPEN und setFileName().

[since 6.3] bool QFile::open(QIODeviceBase::OpenMode mode, QFileDevice::Permissions permissions)

Dies ist eine überladene Funktion.

Wenn die Datei nicht existiert und mode ihre Erstellung impliziert, wird sie mit dem angegebenen permissions erstellt.

Auf POSIX-Systemen werden die tatsächlichen Berechtigungen durch den Wert von umask beeinflusst.

Unter Windows werden die Berechtigungen durch ACLs emuliert. Diese ACLs können in nicht-kanonischer Reihenfolge sein, wenn der Gruppe weniger Rechte als anderen gewährt werden. Dateien und Verzeichnisse mit solchen Berechtigungen erzeugen Warnungen, wenn die Registerkarte Sicherheit im Dialogfeld Eigenschaften geöffnet wird. Wenn Sie der Gruppe alle Rechte gewähren, die anderen gewährt werden, werden solche Warnungen vermieden.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch QIODevice::OpenMode, setFileName(), und QT_USE_NODISCARD_FILE_OPEN.

bool QFile::open(FILE *fh, QIODeviceBase::OpenMode mode, QFileDevice::FileHandleFlags handleFlags = DontCloseHandle)

Dies ist eine überladene Funktion.

Öffnet das vorhandene Dateihandle fh in der angegebenen mode. handleFlags kann verwendet werden, um zusätzliche Optionen anzugeben. Gibt bei Erfolg true zurück, andernfalls false.

Beispiel:

#include <stdio.h>

void printError(const char* msg)
{
    QFile file;
    file.open(stderr, QIODevice::WriteOnly);
    file.write(msg, qstrlen(msg));        // write to stderr
    file.close();
}

Wenn ein QFile mit dieser Funktion geöffnet wird, wird das Verhalten von close() durch das AutoCloseHandle-Flag gesteuert. Wenn AutoCloseHandle angegeben ist und diese Funktion erfolgreich ist, dann schließt der Aufruf von close() das übernommene Handle. Andernfalls schließt close() die Datei nicht wirklich, sondern leert sie nur.

Warnung:

1. Wenn fh nicht auf eine reguläre Datei verweist, z. B. stdin, stdout oder stderr, können Sie seek() möglicherweise nicht verwenden. size() gibt in diesen Fällen 0 zurück. Siehe QIODevice::isSequential() für weitere Informationen.
2. Da diese Funktion die Datei ohne Angabe des Dateinamens öffnet, können Sie diese QFile nicht mit einer QFileInfo verwenden.

Hinweis für die Windows-Plattform

fh muss im Binärmodus geöffnet werden (d.h. der Modus-String muss 'b' enthalten, wie in "rb" oder "wb"), wenn auf Dateien und andere Random-Access-Geräte zugegriffen wird. Qt übersetzt die Zeilenende-Zeichen, wenn Sie QIODevice::Text an mode übergeben. Sequentielle Geräte, wie stdin und stdout, sind von dieser Einschränkung nicht betroffen.

Sie müssen die Unterstützung für Konsolenanwendungen aktivieren, um die Streams stdin, stdout und stderr an der Konsole verwenden zu können. Fügen Sie dazu die folgende Erklärung in die Projektdatei Ihrer Anwendung ein:

CONFIG += console

Siehe auch close() und QT_USE_NODISCARD_FILE_OPEN.

bool QFile::open(int fd, QIODeviceBase::OpenMode mode, QFileDevice::FileHandleFlags handleFlags = DontCloseHandle)

Dies ist eine überladene Funktion.

Öffnet den vorhandenen Dateideskriptor fd in der angegebenen mode. handleFlags kann verwendet werden, um zusätzliche Optionen anzugeben. Gibt bei Erfolg true zurück, andernfalls false.

Wenn ein QFile mit dieser Funktion geöffnet wird, wird das Verhalten von close() durch das AutoCloseHandle-Flag gesteuert. Wenn AutoCloseHandle angegeben ist und diese Funktion erfolgreich ist, dann schließt der Aufruf von close() das übernommene Handle. Andernfalls schließt close() die Datei nicht wirklich, sondern leert sie nur.

Siehe auch close() und QT_USE_NODISCARD_FILE_OPEN.

[override virtual] QFileDevice::Permissions QFile::permissions() const

Reimplements: QFileDevice::permissions() const.

Siehe auch setPermissions().

[static] QFileDevice::Permissions QFile::permissions(const QString &fileName)

Dies ist eine überladene Funktion.

Gibt die komplette ODER-verknüpfte Kombination von QFile::Permission für fileName zurück.

[static, since 6.0] QFileDevice::Permissions QFile::permissions(const std::filesystem::path &filename)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

bool QFile::remove()

Entfernt die durch fileName() angegebene Datei. Gibt bei Erfolg true zurück, andernfalls false.

Die Datei wird geschlossen, bevor sie entfernt wird.

Siehe auch setFileName().

[static] bool QFile::remove(const QString &fileName)

Dies ist eine überladene Funktion.

Entfernt die durch die angegebene fileName spezifizierte Datei.

Gibt bei Erfolg true zurück, andernfalls false.

Siehe auch remove().

bool QFile::rename(const QString &newName)

Benennt die aktuell durch fileName() angegebene Datei in newName um. Bei Erfolg wird true zurückgegeben, andernfalls false.

Wenn eine Datei mit dem Namen newName bereits existiert, gibt rename() false zurück (d.h. QFile wird nicht überschrieben).

Die Datei wird geschlossen, bevor sie umbenannt wird.

Wenn der Umbenennungsvorgang fehlschlägt, versucht Qt, den Inhalt dieser Datei nach newName zu kopieren und diese Datei dann zu entfernen, wobei nur newName erhalten bleibt. Wenn dieser Kopiervorgang fehlschlägt oder diese Datei nicht entfernt werden kann, wird die Zieldatei newName entfernt, um den alten Zustand wiederherzustellen.

Siehe auch setFileName().

[since 6.0] bool QFile::rename(const std::filesystem::path &newName)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

[static] bool QFile::rename(const QString &oldName, const QString &newName)

Dies ist eine überladene Funktion.

Benennt die Datei oldName in newName um. Gibt bei Erfolg true zurück, andernfalls false.

Wenn eine Datei mit dem Namen newName bereits existiert, gibt rename() false zurück (d.h. QFile überschreibt sie nicht).

Siehe auch rename().

[override virtual] bool QFile::resize(qint64 sz)

Reimplements: QFileDevice::resize(qint64 sz).

[static] bool QFile::resize(const QString &fileName, qint64 sz)

Dies ist eine überladene Funktion.

Setzt fileName auf die Größe (in Bytes) sz. Gibt true zurück, wenn die Größenänderung erfolgreich war; andernfalls false. Wenn sz größer ist als fileName, werden die neuen Bytes auf 0 gesetzt, wenn sz kleiner ist, wird die Datei einfach abgeschnitten.

Siehe auch resize().

void QFile::setFileName(const QString &name)

Legt die name der Datei fest. Der Name kann keinen Pfad, einen relativen Pfad oder einen absoluten Pfad haben.

Rufen Sie diese Funktion nicht auf, wenn die Datei bereits geöffnet wurde.

Wenn der Dateiname keinen Pfad oder einen relativen Pfad enthält, wird der Pfad verwendet, der zum Zeitpunkt des Aufrufs von open ( ) der aktuelle Verzeichnispfad der Anwendung ist.

Beispiel:

QFile file;
QDir::setCurrent("/tmp");
file.setFileName("readme.txt");
QDir::setCurrent("/home");
file.open(QIODevice::ReadOnly);      // opens "/home/readme.txt" under Unix

Beachten Sie, dass das Verzeichnis-Trennzeichen "/" für alle von Qt unterstützten Betriebssysteme funktioniert.

Siehe auch fileName(), QFileInfo, und QDir.

[since 6.0] void QFile::setFileName(const std::filesystem::path &name)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

[override virtual] bool QFile::setPermissions(QFileDevice::Permissions permissions)

Reimplements: QFileDevice::setPermissions(QFileDevice::Permissions permissions).

Setzt die Berechtigungen für die Datei auf den angegebenen permissions. Gibt true zurück, wenn erfolgreich, oder false, wenn die Berechtigungen nicht geändert werden können.

Siehe auch permissions() und setFileName().

[static] bool QFile::setPermissions(const QString &fileName, QFileDevice::Permissions permissions)

Dies ist eine überladene Funktion.

Setzt die Berechtigungen für die Datei fileName auf permissions.

[static, since 6.0] bool QFile::setPermissions(const std::filesystem::path &filename, QFileDevice::Permissions permissionSpec)

Dies ist eine überladene Funktion.

Diese Funktion wurde in Qt 6.0 eingeführt.

[override virtual] qint64 QFile::size() const

Reimplements: QFileDevice::size() const.

[static] QString QFile::symLinkTarget(const QString &fileName)

Gibt den absoluten Pfad der Datei oder des Verzeichnisses zurück, auf das der von fileName angegebene symbolische Link (oder die Verknüpfung unter Windows) verweist, oder gibt eine leere Zeichenfolge zurück, wenn fileName keinem symbolischen Link entspricht.

Dieser Name darf keine existierende Datei darstellen; er ist nur eine Zeichenkette. QFile::exists() gibt true zurück, wenn der Symlink auf eine existierende Datei verweist.

QString QFile::symLinkTarget() const

Dies ist eine überladene Funktion.

Gibt den absoluten Pfad der Datei oder des Verzeichnisses zurück, auf die ein Symlink (oder eine Verknüpfung unter Windows) zeigt, oder eine leere Zeichenkette, wenn das Objekt kein symbolischer Link ist.

Dieser Name darf keine existierende Datei darstellen; er ist nur eine Zeichenkette. QFile::exists() gibt true zurück, wenn der Symlink auf eine existierende Datei zeigt.

Siehe auch fileName() und setFileName().