QgsError class

QgsError is container for error messages (report).

It may contain chain (sort of traceback) of error messages (e.g. GDAL - provider - layer). Higher level messages are appended at the end.

Constructors, destructors, conversion operators

QgsError() defaulted
Constructor for QgsError.
QgsError(const QString& message, const QString& tag)
Constructor with single message.

Public functions

void append(const QString& message, const QString& tag)
Append new error message.
void append(const QgsErrorMessage& message)
Append new error message.
void clear()
Clear error messages.
auto isEmpty() const -> bool
Test if any error is set.
auto message(QgsErrorMessage::Format format = QgsErrorMessage::Html) const -> QString
Full error messages description.
auto messageList() const -> QList<QgsErrorMessage>
messageList return the list of current error messages
auto summary() const -> QString
Short error description, usually the first error in chain, the real error.

Function documentation

QgsError::QgsError(const QString& message, const QString& tag)

Constructor with single message.

Parameters
message error message
tag short description, e.g. GDAL, Provider, Layer

void QgsError::append(const QString& message, const QString& tag)

Append new error message.

Parameters
message error message string
tag error label, for example GDAL, GDAL Provider, Raster layer

void QgsError::append(const QgsErrorMessage& message)

Append new error message.

Parameters
message error message

bool QgsError::isEmpty() const

Test if any error is set.

Returns true if contains error

QString QgsError::message(QgsErrorMessage::Format format = QgsErrorMessage::Html) const

Full error messages description.

Parameters
format output format
Returns error report

QList<QgsErrorMessage> QgsError::messageList() const

messageList return the list of current error messages

Returns current list of error messages

QString QgsError::summary() const

Short error description, usually the first error in chain, the real error.

Returns error description