You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
237 lines
11 KiB
237 lines
11 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/tools/quuid.cpp:40 -->
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<title>QUuid Class</title>
|
|
<style type="text/css"><!--
|
|
fn { margin-left: 1cm; text-indent: -1cm; }
|
|
a:link { color: #004faf; text-decoration: none }
|
|
a:visited { color: #672967; text-decoration: none }
|
|
body { background: #ffffff; color: black; }
|
|
--></style>
|
|
</head>
|
|
<body>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr bgcolor="#E5E5E5">
|
|
<td valign=center>
|
|
<a href="index.html">
|
|
<font color="#004faf">Home</font></a>
|
|
| <a href="classes.html">
|
|
<font color="#004faf">All Classes</font></a>
|
|
| <a href="mainclasses.html">
|
|
<font color="#004faf">Main Classes</font></a>
|
|
| <a href="annotated.html">
|
|
<font color="#004faf">Annotated</font></a>
|
|
| <a href="groups.html">
|
|
<font color="#004faf">Grouped Classes</font></a>
|
|
| <a href="functions.html">
|
|
<font color="#004faf">Functions</font></a>
|
|
</td>
|
|
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QUuid Class Reference</h1>
|
|
|
|
<p>The QUuid class defines a Universally Unique Identifier (UUID).
|
|
<a href="#details">More...</a>
|
|
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
|
|
<p><tt>#include <<a href="quuid-h.html">quuid.h</a>></tt>
|
|
<p><a href="quuid-members.html">List of all member functions.</a>
|
|
<h2>Public Members</h2>
|
|
<ul>
|
|
<li class=fn>enum <a href="#Variant-enum"><b>Variant</b></a> { VarUnknown = -1, NCS = 0, DCE = 2, Microsoft = 6, Reserved = 7 }</li>
|
|
<li class=fn>enum <a href="#Version-enum"><b>Version</b></a> { VerUnknown = -1, Time = 1, EmbeddedPOSIX = 2, Name = 3, Random = 4 }</li>
|
|
<li class=fn><a href="#QUuid"><b>QUuid</b></a> ()</li>
|
|
<li class=fn><a href="#QUuid-2"><b>QUuid</b></a> ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )</li>
|
|
<li class=fn><a href="#QUuid-3"><b>QUuid</b></a> ( const QUuid & orig )</li>
|
|
<li class=fn><a href="#QUuid-4"><b>QUuid</b></a> ( const QString & text )</li>
|
|
<li class=fn>QString <a href="#toString"><b>toString</b></a> () const</li>
|
|
<li class=fn><a href="#operator-QString"><b>operator QString</b></a> () const</li>
|
|
<li class=fn>bool <a href="#isNull"><b>isNull</b></a> () const</li>
|
|
<li class=fn>QUuid & <a href="#operator-eq"><b>operator=</b></a> ( const QUuid & uuid )</li>
|
|
<li class=fn>bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const QUuid & other ) const</li>
|
|
<li class=fn>bool <a href="#operator!-eq"><b>operator!=</b></a> ( const QUuid & other ) const</li>
|
|
<li class=fn>bool <a href="#operator-lt"><b>operator<</b></a> ( const QUuid & other ) const</li>
|
|
<li class=fn>bool <a href="#operator-gt"><b>operator></b></a> ( const QUuid & other ) const</li>
|
|
<li class=fn>QUuid::Variant <a href="#variant"><b>variant</b></a> () const</li>
|
|
<li class=fn>QUuid::Version <a href="#version"><b>version</b></a> () const</li>
|
|
</ul>
|
|
<h2>Static Public Members</h2>
|
|
<ul>
|
|
<li class=fn>QUuid <a href="#createUuid"><b>createUuid</b></a> ()</li>
|
|
</ul>
|
|
<h2>Related Functions</h2>
|
|
<ul>
|
|
<li class=fn>QDataStream & <a href="#operator-lt-lt"><b>operator<<</b></a> ( QDataStream & s, const QUuid & id )</li>
|
|
<li class=fn>QDataStream & <a href="#operator-gt-gt"><b>operator>></b></a> ( QDataStream & s, QUuid & id )</li>
|
|
</ul>
|
|
<hr><a name="details"></a><h2>Detailed Description</h2>
|
|
|
|
|
|
The QUuid class defines a Universally Unique Identifier (UUID).
|
|
<p>
|
|
<p> For objects or declarations that must be uniquely identified,
|
|
UUIDs (also known as GUIDs) are widely used in order to assign a
|
|
fixed and easy to compare value to the object or declaration. The
|
|
128-bit value of a UUID is generated by an algorithm that
|
|
guarantees that the value is unique.
|
|
<p> In Qt, UUIDs are wrapped by the QUuid struct which provides
|
|
convenience functions for handling UUIDs. Most platforms provide a
|
|
tool to generate new UUIDs, for example, uuidgen and guidgen.
|
|
<p> UUIDs generated by QUuid, are based on the <a href="#Version-enum">Random</a> version of the
|
|
<a href="#Variant-enum">DCE</a> (Distributed Computing Environment) standard.
|
|
<p> UUIDs can be constructed from numeric values or from strings, or
|
|
using the static <a href="#createUuid">createUuid</a>() function. They can be converted to a
|
|
string with <a href="#toString">toString</a>(). UUIDs have a <a href="#variant">variant</a>() and a <a href="#version">version</a>(),
|
|
and null UUIDs return TRUE from <a href="#isNull">isNull</a>().
|
|
|
|
<hr><h2>Member Type Documentation</h2>
|
|
<h3 class=fn><a name="Variant-enum"></a>QUuid::Variant</h3>
|
|
|
|
<p> This enum defines the variant of the UUID, which is the scheme
|
|
which defines the layout of the 128-bits value.
|
|
<ul>
|
|
<li><tt>QUuid::VarUnknown</tt> - Variant is unknown
|
|
<li><tt>QUuid::NCS</tt> - Reserved for NCS (Network Computing System) backward compatibility
|
|
<li><tt>QUuid::DCE</tt> - Distributed Computing Environment, the scheme used by QUuid
|
|
<li><tt>QUuid::Microsoft</tt> - Reserved for Microsoft backward compatibility (GUID)
|
|
<li><tt>QUuid::Reserved</tt> - Reserved for future definition
|
|
</ul>
|
|
<h3 class=fn><a name="Version-enum"></a>QUuid::Version</h3>
|
|
|
|
<p> This enum defines the version of the UUID.
|
|
<ul>
|
|
<li><tt>QUuid::VerUnknown</tt> - Version is unknown
|
|
<li><tt>QUuid::Time</tt> - Time-based, by using timestamp, clock sequence, and
|
|
MAC network card address (if available) for the node sections
|
|
<li><tt>QUuid::EmbeddedPOSIX</tt> - DCE Security version, with embedded POSIX UUIDs
|
|
<li><tt>QUuid::Name</tt> - Name-based, by using values from a name for all sections
|
|
<li><tt>QUuid::Random</tt> - Random-based, by using random numbers for all sections
|
|
</ul>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<h3 class=fn><a name="QUuid"></a>QUuid::QUuid ()
|
|
</h3>
|
|
|
|
<p> Creates the null UUID {00000000-0000-0000-0000-000000000000}.
|
|
|
|
<h3 class=fn><a name="QUuid-2"></a>QUuid::QUuid ( uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8 )
|
|
</h3>
|
|
|
|
<p> Creates a UUID with the value specified by the parameters, <em>l</em>,
|
|
<em>w1</em>, <em>w2</em>, <em>b1</em>, <em>b2</em>, <em>b3</em>, <em>b4</em>, <em>b5</em>, <em>b6</em>, <em>b7</em>, <em>b8</em>.
|
|
<p> Example:
|
|
<pre>
|
|
// {67C8770B-44F1-410A-AB9A-F9B5446F13EE}
|
|
QUuid IID_MyInterface( 0x67c8770b, 0x44f1, 0x410a, 0xab, 0x9a, 0xf9, 0xb5, 0x44, 0x6f, 0x13, 0xee )
|
|
</pre>
|
|
|
|
|
|
<h3 class=fn><a name="QUuid-3"></a>QUuid::QUuid ( const <a href="quuid.html">QUuid</a> & orig )
|
|
</h3>
|
|
|
|
<p> Creates a copy of the QUuid <em>orig</em>.
|
|
|
|
<h3 class=fn><a name="QUuid-4"></a>QUuid::QUuid ( const <a href="qstring.html">QString</a> & text )
|
|
</h3>
|
|
Creates a QUuid object from the string <em>text</em>. The function can
|
|
only convert a string in the format
|
|
{HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH} (where 'H' stands for a hex
|
|
digit). If the conversion fails a null UUID is created.
|
|
|
|
<h3 class=fn><a href="quuid.html">QUuid</a> <a name="createUuid"></a>QUuid::createUuid ()<tt> [static]</tt>
|
|
</h3>
|
|
|
|
<p> Returns a new UUID of <a href="#Variant-enum">DCE</a> variant, and <a href="#Version-enum">Random</a> type. The
|
|
UUIDs generated are based on the platform specific pseudo-random
|
|
generator, which is usually not a cryptographic-quality random
|
|
number generator. Therefore, a UUID is not guaranteed to be unique
|
|
cross application instances.
|
|
<p> On Windows, the new UUID is extremely likely to be unique on the
|
|
same or any other system, networked or not.
|
|
<p> <p>See also <a href="#variant">variant</a>() and <a href="#version">version</a>().
|
|
|
|
<h3 class=fn>bool <a name="isNull"></a>QUuid::isNull () const
|
|
</h3>
|
|
Returns TRUE if this is the null UUID
|
|
{00000000-0000-0000-0000-000000000000}; otherwise returns FALSE.
|
|
|
|
<h3 class=fn><a name="operator-QString"></a>QUuid::operator QString () const
|
|
</h3>
|
|
|
|
<p> Returns the string representation of the uuid.
|
|
<p> <p>See also <a href="#toString">toString</a>().
|
|
|
|
<h3 class=fn>bool <a name="operator!-eq"></a>QUuid::operator!= ( const <a href="quuid.html">QUuid</a> & other ) const
|
|
</h3>
|
|
|
|
<p> Returns TRUE if this QUuid and the <em>other</em> QUuid are different;
|
|
otherwise returns FALSE.
|
|
|
|
<h3 class=fn>bool <a name="operator-lt"></a>QUuid::operator< ( const <a href="quuid.html">QUuid</a> & other ) const
|
|
</h3>
|
|
|
|
<p> Returns TRUE if this QUuid is of the same variant,
|
|
and lexicographically before the <em>other</em> QUuid;
|
|
otherwise returns FALSE.
|
|
<p> <p>See also <a href="#variant">variant</a>().
|
|
|
|
<h3 class=fn><a href="quuid.html">QUuid</a> & <a name="operator-eq"></a>QUuid::operator= ( const <a href="quuid.html">QUuid</a> & uuid )
|
|
</h3>
|
|
|
|
<p> Assigns the value of <em>uuid</em> to this QUuid object.
|
|
|
|
<h3 class=fn>bool <a name="operator-eq-eq"></a>QUuid::operator== ( const <a href="quuid.html">QUuid</a> & other ) const
|
|
</h3>
|
|
|
|
<p> Returns TRUE if this QUuid and the <em>other</em> QUuid are identical;
|
|
otherwise returns FALSE.
|
|
|
|
<h3 class=fn>bool <a name="operator-gt"></a>QUuid::operator> ( const <a href="quuid.html">QUuid</a> & other ) const
|
|
</h3>
|
|
|
|
<p> Returns TRUE if this QUuid is of the same variant,
|
|
and lexicographically after the <em>other</em> QUuid;
|
|
otherwise returns FALSE.
|
|
<p> <p>See also <a href="#variant">variant</a>().
|
|
|
|
<h3 class=fn><a href="qstring.html">QString</a> <a name="toString"></a>QUuid::toString () const
|
|
</h3>
|
|
<a href="qstring.html">QString</a> <a href="#toString">QUuid::toString</a>() const
|
|
<p> Returns the string representation of the uuid.
|
|
|
|
<h3 class=fn><a href="quuid.html#Variant-enum">QUuid::Variant</a> <a name="variant"></a>QUuid::variant () const
|
|
</h3>
|
|
|
|
<p> Returns the variant of the UUID.
|
|
The null UUID is considered to be of an unknown variant.
|
|
<p> <p>See also <a href="#version">version</a>().
|
|
|
|
<h3 class=fn><a href="quuid.html#Version-enum">QUuid::Version</a> <a name="version"></a>QUuid::version () const
|
|
</h3>
|
|
|
|
<p> Returns the version of the UUID, if the UUID is of the DCE
|
|
variant; otherwise returns VerUnknown.
|
|
<p> <p>See also <a href="#variant">variant</a>().
|
|
|
|
<hr><h2>Related Functions</h2>
|
|
<h3 class=fn><a href="qdatastream.html">QDataStream</a> & <a name="operator-lt-lt"></a>operator<< ( <a href="qdatastream.html">QDataStream</a> & s, const <a href="quuid.html">QUuid</a> & id )
|
|
</h3>
|
|
|
|
Writes the uuid <em>id</em> to the datastream <em>s</em>.
|
|
|
|
<h3 class=fn><a href="qdatastream.html">QDataStream</a> & <a name="operator-gt-gt"></a>operator>> ( <a href="qdatastream.html">QDataStream</a> & s, <a href="quuid.html">QUuid</a> & id )
|
|
</h3>
|
|
|
|
Reads uuid from from the stream <em>s</em> into <em>id</em>.
|
|
|
|
<!-- eof -->
|
|
<hr><p>
|
|
This file is part of the <a href="index.html">Qt toolkit</a>.
|
|
Copyright © 1995-2007
|
|
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|
<table width=100% cellspacing=0 border=0><tr>
|
|
<td>Copyright © 2007
|
|
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|
<td align=right><div align=right>Qt 3.3.8</div>
|
|
</table></div></address></body>
|
|
</html>
|