QFile Class

Dokumentation zu Mitgliedsfunktionen

QFile::QFile()

Erstellt ein QFile-Objekt.

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

Erstellt ein neues Dateiobjekt mit dem angegebenen „ parent “.

[explicit] QFile::QFile(const QString &name)

Erstellt ein neues Dateiobjekt, das die Datei mit dem angegebenen Pfad „ name “ repräsentiert.

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

Erstellt ein neues Dateiobjekt, das die Datei mit dem angegebenen „ name “ darstellt.

Diese Funktion wurde in Qt 6.0 eingeführt.

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

Erstellt ein neues Dateiobjekt mit dem angegebenen „ parent “, um die Datei mit dem angegebenen „ name “ darzustellen.

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

Erstellt ein neues Dateiobjekt mit dem angegebenen ` parent `, um die Datei mit dem angegebenen ` name` darzustellen.

Diese Funktion wurde in Qt 6.0 eingeführt.

[virtual noexcept] QFile::~QFile()

Löscht das Dateiobjekt und schließt es gegebenenfalls.

bool QFile::copy(const QString &newName, std::optional<QFileDevice::Permissions> perm = std::nullopt)

Kopiert die Datei mit dem Namen „ fileName “ () in den Ordner „ newName “.

Diese Datei wird vor dem Kopieren geschlossen.

Seit Qt 6.12 können beim Aufruf die Berechtigungen perm angegeben werden. Werden diese nicht übergeben, werden die Berechtigungen der Originaldatei kopiert. Die neue Datei wird mit den angegebenen Berechtigungen erstellt.

Ist die kopierte Datei ein symbolischer Link (Symlink), wird die Datei kopiert, auf die er verweist, nicht der Link selbst. Mit Ausnahme der Berechtigungen werden keine weiteren Dateimetadaten kopiert.

Gibt bei Erfolg ` true ` zurück; andernfalls wird ` false` zurückgegeben.

Beachten Sie: Wenn bereits eine Datei mit dem Namen „ newName “ existiert, gibt „copy()“ „ false “ zurück. Das bedeutet, dass „ QFile “ diese Datei nicht überschreibt. Der Vorgang ist jedoch nicht atomar. Es besteht die Möglichkeit, dass ein anderer Prozess zwischen der Überprüfung und dem Kopieren eine Datei mit dem Namen „ newName “ erstellt. In diesem Fall wird die Datei überschrieben.

Siehe auch setFileName().

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

Diese Funktion wurde in Qt 6.0 eingeführt.

[static] bool QFile::copy(const QString &fileName, const QString &newName, std::optional<QFileDevice::Permissions> perm = std::nullopt)

Kopiert die Datei mit dem Namen „ fileName “ nach „ newName “.

Seit Qt 6.12 können die Berechtigungen „ perm “ beim Aufruf angegeben werden. Werden diese nicht übergeben, werden die Berechtigungen der Originaldatei kopiert. Die neue Datei wird mit den angegebenen Berechtigungen angelegt.

Ist die kopierte Datei ein symbolischer Link (Symlink), wird die Datei kopiert, auf die er verweist, nicht der Link selbst. Mit Ausnahme der Zugriffsrechte werden keine weiteren Dateimetadaten kopiert.

Gibt bei Erfolg ` true ` zurück; andernfalls wird ` false` zurückgegeben.

Beachten Sie, dass copy(), falls bereits eine Datei mit dem Namen newName existiert, false zurückgibt. Das bedeutet, dass QFile diese Datei nicht überschreibt. Der Vorgang ist jedoch nicht atomar. Es besteht die Möglichkeit, dass ein anderer Prozess zwischen der Überprüfung und dem Kopieren eine Datei mit dem Namen newName erstellt. In diesem Fall wird die Datei überschrieben.

Siehe auch rename().

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

Dies führt das Gegenteil von „ QFile::encodeName()“ aus, wobei „ localFileName “ verwendet wird.

Siehe auch encodeName().

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

Gibt die Unicode-Version des angegebenen ` localFileName` zurück. Weitere Informationen finden Sie unter ` encodeName()`.

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

Konvertiert „ fileName “ in eine 8-Bit-Kodierung, die Sie in nativen APIs verwenden können. Unter Windows entspricht die Kodierung der aktiven Windows-Codepage (ANSI). Auf anderen Plattformen ist dies UTF-8, unter macOS in zerlegter 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

Gibt „ true “ zurück, wenn die durch ` fileName()` angegebene Datei existiert; andernfalls wird „ false “ zurückgegeben.

Siehe auch fileName() und setFileName().

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

Implementiert: ` QFileDevice::fileName()` const.

Gibt den Namen der Datei zurück, wie er durch ` setFileName()`, ` rename()` oder durch die Konstruktoren von ` QFile ` festgelegt wurde.

Siehe auch setFileName(), rename() 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)

Erstellt einen Link mit dem Namen „ linkName “, der auf die Datei verweist, die derzeit durch „ fileName()“ angegeben ist. 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 wird „ false “ zurückgegeben.

Diese Funktion überschreibt keine bereits im Dateisystem vorhandene Entität; in diesem Fall gibt „ link() “ „false“ zurück und setzt „ error()“ so, dass „ RenameError “ zurückgegeben wird.

Siehe auch ` setFileName()`.

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

Diese Funktion wurde in Qt 6.0 eingeführt.

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

Erstellt einen Link mit dem Namen „ linkName “, der auf die Datei „ fileName “ verweist. Was genau ein solcher 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 Ausführungszeit dieser Funktion ist unabhängig von der Größe der in den Papierkorb verschobenen Datei. Wird diese Funktion für ein Verzeichnis aufgerufen, kann sie proportional zur Anzahl der in den Papierkorb verschobenen Dateien sein. Wenn der aktuelle fileName() auf einen symbolischen Link verweist, verschiebt diese Funktion den Link in den Papierkorb, wodurch dieser möglicherweise unbrauchbar wird – nicht jedoch das Ziel des Links.

Diese Funktion nutzt die Windows- und macOS-APIs, um das Verschieben in den Papierkorb auf diesen beiden Betriebssystemen durchzuführen. Auf anderen Systemen (Unix-Systemen) implementiert diese Funktion die FreeDesktop.org-Papierkorb-Spezifikation Version 1.0.

Siehe auch supportsMoveToTrash(), remove() und QDir::remove().

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

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

Die Ausführungszeit dieser Funktion ist unabhängig von der Größe der in den Papierkorb verschobenen Datei. Wird diese Funktion für ein Verzeichnis aufgerufen, kann sie proportional zur Anzahl der in den Papierkorb verschobenen Dateien sein. Wenn der aktuelle fileName() auf einen symbolischen Link verweist, verschiebt diese Funktion den Link in den Papierkorb, wodurch dieser möglicherweise unbrauchbar wird – nicht jedoch das Ziel des Links.

Diese Funktion nutzt die Windows- und macOS-APIs, um das Verschieben in den Papierkorb auf diesen beiden Betriebssystemen durchzuführen. Auf anderen Systemen (Unix-Systemen) implementiert diese Funktion die FreeDesktop.org-Papierkorb-Spezifikation Version 1.0.

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

Implementiert: QIODevice::open(QIODeviceBase::OpenMode-Modus).

Öffnet die Datei unter Verwendung der Flags von „ mode “ und gibt bei Erfolg „ true “ zurück; andernfalls wird „ false “ zurückgegeben.

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

Siehe auch QT_USE_NODISCARD_FILE_OPEN und setFileName().

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

Wenn die Datei nicht existiert und „ mode “ bedeutet, dass sie angelegt werden soll, wird sie mit den angegebenen Berechtigungen „ permissions “ angelegt.

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

Unter Windows werden die Berechtigungen mithilfe von ACLs emuliert. Diese ACLs können in nicht-kanonischer Reihenfolge vorliegen, wenn der Gruppe weniger Berechtigungen gewährt werden als anderen. Dateien und Verzeichnisse mit solchen Berechtigungen lösen Warnungen aus, wenn die Registerkarte „Sicherheit“ des Eigenschaften-Dialogfelds geöffnet wird. Durch die Gewährung aller Berechtigungen, die anderen gewährt werden, an die Gruppe lassen sich solche Warnungen vermeiden.

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)

Öffnet das vorhandene Datei-Handle „ fh “ in der angegebenen Datei „ mode “. Mit „ handleFlags “ können zusätzliche Optionen festgelegt werden. Gibt bei Erfolg „ true “ zurück; andernfalls wird „ false “ zurückgegeben.

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 Flag `AutoCloseHandle` gesteuert. Ist `AutoCloseHandle` angegeben und diese Funktion erfolgreich, schließt der Aufruf von ` close()` das übernommene Handle. Andernfalls schließt ` close()` die Datei nicht tatsächlich, sondern führt lediglich einen Flush durch.

Warnung:

1. Wenn sich „ fh “ nicht auf eine reguläre Datei bezieht, z. B. wenn es sich um „ stdin “, „ stdout “ oder „ stderr “ handelt, ist der Aufruf von „ seek()“ möglicherweise nicht möglich. „ size()“ gibt in diesen Fällen „ 0 “ zurück. Weitere Informationen finden Sie unter „ QIODevice::isSequential()“.
2. Da diese Funktion die Datei ohne Angabe eines Dateinamens öffnet, können Sie diese Funktion QFile nicht mit einem QFileInfo verwenden.

Hinweis für die Windows-Plattform

fh müssen beim Zugriff auf Dateien und andere Geräte mit wahlfreiem Zugriff im Binärmodus geöffnet werden (d. h., die Moduszeichenfolge muss ein „b“ enthalten, wie in „rb“ oder „wb“). Qt konvertiert die Zeilenendezeichen, wenn Sie QIODevice::Text an ` mode` übergeben. Sequenzielle 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 nutzen zu können. Fügen Sie dazu die folgende Deklaration 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)

Öffnet den vorhandenen Dateideskriptor „ fd “ im angegebenen Verzeichnis „ mode “. Mit „ handleFlags “ können zusätzliche Optionen angegeben werden. Gibt bei Erfolg „ true “ zurück; andernfalls wird „ false “ zurückgegeben.

Wenn ein ` QFile ` mit dieser Funktion geöffnet wird, wird das Verhalten von ` close()` durch das Flag `AutoCloseHandle` gesteuert. Ist `AutoCloseHandle` gesetzt und diese Funktion erfolgreich, wird das übernommene Handle durch den Aufruf von ` close()` geschlossen. Andernfalls schließt ` close()` die Datei nicht tatsächlich, sondern führt lediglich einen Flush durch.

Siehe auch close() und QT_USE_NODISCARD_FILE_OPEN.

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

Implementiert neu: QFileDevice::permissions() const.

Siehe auch setPermissions().

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

Gibt die vollständige, mit „OR“ verknüpfte Kombination von QFile::Permission für „ fileName “ zurück.

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

Diese Funktion wurde in Qt 6.0 eingeführt.

bool QFile::remove()

Entfernt die durch fileName() angegebene Datei.

Gibt ` true ` zurück, wenn die Datei erfolgreich entfernt wurde; andernfalls wird ` false` zurückgegeben.

Die Datei wird vor dem Löschen geschlossen, sofern sie geöffnet war.

Siehe auch setFileName().

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

Entfernt die durch den angegebenen „ fileName “ angegebene Datei.

Gibt ` true ` zurück, wenn die Datei erfolgreich entfernt wurde; andernfalls wird ` false` zurückgegeben.

Siehe auch ` remove()`.

bool QFile::rename(const QString &newName)

Benennt die derzeit durch ` fileName()` angegebene Datei in ` newName` um. Gibt bei Erfolg ` true ` zurück; andernfalls wird ` false` zurückgegeben.

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

Die Datei wird vor der Umbenennung geschlossen.

Fällt der Umbenennungsvorgang fehl, versucht Qt, den Inhalt dieser Datei nach „ newName “ zu kopieren und anschließend diese Datei zu entfernen, wobei nur „ newName “ erhalten bleibt. Fällt dieser Kopiervorgang fehl oder kann diese Datei nicht entfernt werden, wird die Zieldatei „ newName “ entfernt, um den alten Zustand wiederherzustellen.

Siehe auch setFileName().

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

Diese Funktion wurde in Qt 6.0 eingeführt.

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

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

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

Siehe auch ` rename()`.

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

Implementiert: QFileDevice::resize(qint64 sz).

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

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

Siehe auch ` resize()`.

void QFile::setFileName(const QString &name)

Legt den Dateinamen „ name “ fest. Der Name kann ohne Pfad, als relativer Pfad oder als absoluter Pfad angegeben werden.

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

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

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 Verzeichnistrennzeichen „/“ 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)

Diese Funktion wurde in Qt 6.0 eingeführt.

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

Implementiert: QFileDevice::setPermissions(Berechtigungen von QFileDevice::Permissions).

Legt die Berechtigungen für die Datei gemäß dem angegebenen permissions fest. Gibt bei Erfolg „ true “ zurück 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)

Legt die Berechtigungen für die Datei „ fileName “ auf „ permissions “ fest.

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

Diese Funktion wurde in Qt 6.0 eingeführt.

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

Implementiert erneut: ` QFileDevice::size()` const.

[static, since 6.9] bool QFile::supportsMoveToTrash()

Gibt „ true “ zurück, wenn Qt das Verschieben von Dateien in den Papierkorb des aktuellen Betriebssystems mithilfe der Funktion „ moveToTrash()“ unterstützt, andernfalls „ false “. Beachten Sie, dass die Rückgabe von „ true “ durch diese Funktion nicht bedeutet, dass „ moveToTrash()“ erfolgreich sein wird. Insbesondere prüft diese Funktion nicht, ob der Benutzer die Funktion in seinen Einstellungen deaktiviert hat.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch ` moveToTrash()`.

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

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

Dieser Name muss nicht unbedingt eine existierende Datei bezeichnen; es handelt sich lediglich um eine Zeichenkette. QFile::exists() gibt true zurück, wenn der symbolische Link auf eine existierende Datei verweist.

QString QFile::symLinkTarget() const

Gibt den absoluten Pfad der Datei oder des Verzeichnisses zurück, auf die bzw. das ein symbolischer Link (oder unter Windows eine Verknüpfung) verweist, oder eine leere Zeichenkette, wenn es sich bei dem Objekt nicht um einen symbolischen Link handelt.

Dieser Name muss nicht unbedingt eine existierende Datei bezeichnen; es handelt sich lediglich um eine Zeichenkette. ` QFile::exists()` gibt ` true ` zurück, wenn der symbolische Link auf eine existierende Datei verweist.

Siehe auch fileName() und setFileName().