Spec-Zone.ru › Qt

Класс QTemporaryDir

Класс QTemporaryDir создаёт уникальную директорию для временного использования. Подробнее...

Заголовок: #include <QTemporaryDir>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
  • Список всех членов, включая наследуемые

Примечание: Все функции в этом классе являются повторно входящими.

Открытые функции

QTemporaryDir(const QString &templatePath)
QTemporaryDir()
~QTemporaryDir()
bool autoRemove() const
QString errorString() const
QString filePath(const QString &fileName) const
bool isValid() const
QString path() const
bool remove()
void setAutoRemove(bool b)

Подробное описание

QTemporaryDir используется для безопасного создания уникальных временных каталогов. Сама директория создаётся конструктором. Имя временной директории гарантированно уникально (т.е. вы гарантированно не перезапишете существующую директорию), а директория будет удалена при уничтожении объекта QTemporaryDir. Имя директории либо автоматически генерируется, либо создаётся на основе шаблона, который передаётся в конструктор QTemporaryDir.

Пример:

    // Within a function/method...

    QTemporaryDir dir;
    if (dir.isValid()) {
        // dir.path() returns the unique directory path
    }

    // The QTemporaryDir destructor removes the temporary directory
    // as it goes out of scope.

Очень важно проверить, что временная директория могла быть создана, используя isValid(). Не используйте exists(), так как QDir по умолчанию представляет текущую директорию, которая существует.

Путь к временной директории можно получить, вызвав path().

Временная директория будет иметь статическую часть имени и часть, вычисленную для уникальности. Путь по умолчанию будет определён из QCoreApplication::applicationName() (в противном случае qt_temp) и будет помещён во временный путь, возвращённый QDir::tempPath(). Если вы укажете свой собственный путь, относительный путь по умолчанию не будет помещён во временную директорию, а будет относительным к текущей рабочей директории. Во всех случаях к пути будет добавлен случайный строковый идентификатор для его уникализации.

См. также QDir::tempPath(), QDir и QTemporaryFile.

Документация по функциям-членам

QTemporaryDir::QTemporaryDir(const QString &templatePath)

Конструирует QTemporaryDir с шаблоном templatePath.

Если templatePath — относительный путь, то он будет относительным к текущей рабочей директории. Вы можете использовать QDir::tempPath() для построения templatePath, если вы хотите использовать системную временную директорию.

Если templatePath оканчивается на XXXXXX, он будет использоваться как динамическая часть имени директории; иначе он будет добавлен. В отличие от QTemporaryFile, XXXXXX посреди шаблона не поддерживается.

См. также QDir::tempPath().

QTemporaryDir::QTemporaryDir()

Конструирует QTemporaryDir, используя в качестве шаблона имя приложения, возвращаемое QCoreApplication::applicationName() (в противном случае qt_temp). Директория хранится в системной временной директории, QDir::tempPath().

См. также QDir::tempPath().

QTemporaryDir::~QTemporaryDir()

Уничтожает объект временной директории. Если был установлен режим автоматического удаления, директория будет автоматически удалена, включая все её содержимое.

См. также autoRemove().

bool QTemporaryDir::autoRemove() const

Возвращает true если QTemporaryDir находится в режиме автоматического удаления. Режим автоматического удаления автоматически удалит директорию с диска при уничтожении. Это очень упрощает создание объекта QTemporaryDir на стеке, заполнение его файлами, выполнение действий с файлами и, наконец, автоматическое очищение после возврата из функции.

Авто-удаление включено по умолчанию.

См. также setAutoRemove() и remove().

[since 5.6] QString QTemporaryDir::errorString() const

Если isValid() возвращает false, эта функция возвращает строку ошибки, объясняющую, почему создание временной директории не удалось. В противном случае эта функция возвращает пустую строку.

Эта функция была добавлена в Qt 5.6.

[since 5.9] QString QTemporaryDir::filePath(const QString &fileName) const

Возвращает имя пути файла во временной директории. Не проверяет, существует ли файл в директории. Избыточные множественные разделители или директории "." и ".." в fileName не удаляются (см. QDir::cleanPath()). Абсолютные пути не допускаются.

Эта функция была добавлена в Qt 5.9.

bool QTemporaryDir::isValid() const

Возвращает true если QTemporaryDir был создан успешно.

QString QTemporaryDir::path() const

Возвращает путь к временной директории. Пустая строка, если QTemporaryDir не удалось создать.

bool QTemporaryDir::remove()

Удаляет временную директорию, включая всё её содержимое.

Возвращает true если удаление прошло успешно.

void QTemporaryDir::setAutoRemove(bool b)

Устанавливает QTemporaryDir в режим автоматического удаления, если b равно true.

Авто-удаление включено по умолчанию.

См. также autoRemove() и remove().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qtemporarydir.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API