Spec-Zone.ru › Qt 5.14

Класс QTemporaryDir

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

Заголовок: #include <QTemporaryDir>
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().

QString QTemporaryDir::errorString() const

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

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

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-5.14/qtemporarydir.html

Spec-Zone.ru

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