QUuid Class

Member Function Documentation

QUuid::QUuid()

Creates the null UUID. toString() will output the null UUID as "{00000000-0000-0000-0000-000000000000}".

QUuid::QUuid(uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8)

Creates a UUID with the value specified by the parameters, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8.

Example:

// {67C8770B-44F1-410A-AB9A-F9B5446F13EE}
QUuid IID_MyInterface(0x67c8770b, 0x44f1, 0x410a, 0xab, 0x9a, 0xf9, 0xb5, 0x44, 0x6f, 0x13, 0xee);

QUuid::QUuid(const QString &text)

Creates a QUuid object from the string text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex digit. The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is created. See toString() for an explanation of how the five hex fields map to the public data members in QUuid.

See also toString() and QUuid().

QUuid::QUuid(const QByteArray &text)

Creates a QUuid object from the QByteArray text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex digit. The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is created. See toByteArray() for an explanation of how the five hex fields map to the public data members in QUuid.

This function was introduced in Qt 4.8.

See also toByteArray() and QUuid().

QUuid::QUuid(const GUID &guid)

Casts a Windows guid to a Qt QUuid.

Warning: This function is only for Windows platforms.

[static] QUuid QUuid::createUuid()

On any platform other than Windows, this function returns a new UUID with variant QUuid::DCE and version QUuid::Random. On Windows, a GUID is generated using the Windows API and will be of the type that the API decides to create.

See also variant() and version().

[static] QUuid QUuid::createUuidV3(const QUuid &ns, const QByteArray &baseData)

This function returns a new UUID with variant QUuid::DCE and version QUuid::Md5. ns is the namespace and baseData is the basic data as described by RFC 4122.

This function was introduced in Qt 5.0.

See also variant(), version(), and createUuidV5().

[static] QUuid QUuid::createUuidV3(const QUuid &ns, const QString &baseData)

This function returns a new UUID with variant QUuid::DCE and version QUuid::Md5. ns is the namespace and baseData is the basic data as described by RFC 4122.

This function was introduced in Qt 5.0.

See also variant(), version(), and createUuidV5().

[static] QUuid QUuid::createUuidV5(const QUuid &ns, const QByteArray &baseData)

This function returns a new UUID with variant QUuid::DCE and version QUuid::Sha1. ns is the namespace and baseData is the basic data as described by RFC 4122.

This function was introduced in Qt 5.0.

See also variant(), version(), and createUuidV3().

[static] QUuid QUuid::createUuidV5(const QUuid &ns, const QString &baseData)

This function returns a new UUID with variant QUuid::DCE and version QUuid::Sha1. ns is the namespace and baseData is the basic data as described by RFC 4122.

This function was introduced in Qt 5.0.

See also variant(), version(), and createUuidV3().

[static] QUuid QUuid::fromCFUUID(CFUUIDRef uuid)

Constructs a new QUuid containing a copy of the uuid CFUUID.

Note: this function is only available on Apple platforms.

This function was introduced in Qt 5.7.

[static] QUuid QUuid::fromNSUUID(const NSUUID *uuid)

Constructs a new QUuid containing a copy of the uuid NSUUID.

Note: this function is only available on Apple platforms.

This function was introduced in Qt 5.7.

[static] QUuid QUuid::fromRfc4122(const QByteArray &bytes)

Creates a QUuid object from the binary representation of the UUID, as specified by RFC 4122 section 4.1.2. See toRfc4122() for a further explanation of the order of bytes required.

The byte array accepted is NOT a human readable format.

If the conversion fails, a null UUID is created.

This function was introduced in Qt 4.8.

See also toRfc4122() and QUuid().

[static] QUuid QUuid::fromString(QStringView text)

Creates a QUuid object from the string text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex digit. The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is returned. See toString() for an explanation of how the five hex fields map to the public data members in QUuid.

This function was introduced in Qt 5.10.

See also toString() and QUuid().

[static] QUuid QUuid::fromString(QLatin1String text)

This is an overloaded function.

Creates a QUuid object from the string text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex digit. The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is returned. See toString() for an explanation of how the five hex fields map to the public data members in QUuid.

This function was introduced in Qt 5.10.

See also toString() and QUuid().

bool QUuid::isNull() const

Returns true if this is the null UUID {00000000-0000-0000-0000-000000000000}; otherwise returns false.

QByteArray QUuid::toByteArray() const

Returns the binary representation of this QUuid. The byte array is formatted as five hex fields separated by '-' and enclosed in curly braces, i.e., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:

This function was introduced in Qt 4.8.

QByteArray QUuid::toByteArray(QUuid::StringFormat mode) const

Returns the string representation of this QUuid, with the formattiong controlled by the mode parameter. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:

This function was introduced in Qt 5.11.

CFUUIDRef QUuid::toCFUUID() const

Creates a CFUUID from a QUuid. The caller owns the CFUUID and is responsible for releasing it.

Note: this function is only available on Apple platforms.

This function was introduced in Qt 5.7.

NSUUID *QUuid::toNSUUID() const

Creates a NSUUID from a QUuid. The NSUUID is autoreleased.

Note: this function is only available on Apple platforms.

This function was introduced in Qt 5.7.

QByteArray QUuid::toRfc4122() const

Returns the binary representation of this QUuid. The byte array is in big endian format, and formatted according to RFC 4122, section 4.1.2 - "Layout and byte order".

The order is as follows:

This function was introduced in Qt 4.8.

QString QUuid::toString() const

Returns the string representation of this QUuid. The string is formatted as five hex fields separated by '-' and enclosed in curly braces, i.e., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:

QString QUuid::toString(QUuid::StringFormat mode) const

Returns the string representation of this QUuid, with the formattiong controlled by the mode parameter. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:

This function was introduced in Qt 5.11.

QUuid::Variant QUuid::variant() const

Returns the value in the variant field of the UUID. If the return value is QUuid::DCE, call version() to see which layout it uses. The null UUID is considered to be of an unknown variant.

See also version().

QUuid::Version QUuid::version() const

Returns the version field of the UUID, if the UUID's variant field is QUuid::DCE. Otherwise it returns QUuid::VerUnknown.

See also variant().

GUID QUuid::operator GUID() const

Returns a Windows GUID from a QUuid.

Warning: This function is only for Windows platforms.

bool QUuid::operator!=(const QUuid &other) const

Returns true if this QUuid and the other QUuid are different; otherwise returns false.

bool QUuid::operator!=(const GUID &guid) const

Returns true if this UUID is not equal to the Windows GUID guid; otherwise returns false.

bool QUuid::operator<(const QUuid &other) const

Returns true if this QUuid has the same variant field as the other QUuid and is lexicographically before the other QUuid. If the other QUuid has a different variant field, the return value is determined by comparing the two variants.

See also variant().

QUuid &QUuid::operator=(const GUID &guid)

Assigns a Windows guid to a Qt QUuid.

Warning: This function is only for Windows platforms.

bool QUuid::operator==(const QUuid &other) const

Returns true if this QUuid and the other QUuid are identical; otherwise returns false.

bool QUuid::operator==(const GUID &guid) const

Returns true if this UUID is equal to the Windows GUID guid; otherwise returns false.

bool QUuid::operator>(const QUuid &other) const

Returns true if this QUuid has the same variant field as the other QUuid and is lexicographically after the other QUuid. If the other QUuid has a different variant field, the return value is determined by comparing the two variants.

See also variant().