summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-07-13 10:48:33 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-07-13 11:29:50 (GMT)
commit0aca5cf05288dc4d2175d1c4a78bf62a5ea96b21 (patch)
tree3a78b849d375a553db786f3b35e7196b91d95765
parent3d55ab91148c13f1905a4c1983d144efb4315297 (diff)
downloadQt-0aca5cf05288dc4d2175d1c4a78bf62a5ea96b21.zip
Qt-0aca5cf05288dc4d2175d1c4a78bf62a5ea96b21.tar.gz
Qt-0aca5cf05288dc4d2175d1c4a78bf62a5ea96b21.tar.bz2
doc: Clarified what Qt::HANDLE is on Windows.
Task-number: 193615
-rw-r--r--doc/src/qnamespace.qdoc5
-rw-r--r--src/corelib/thread/qthread.cpp11
2 files changed, 11 insertions, 5 deletions
diff --git a/doc/src/qnamespace.qdoc b/doc/src/qnamespace.qdoc
index b691ac7..85b020d 100644
--- a/doc/src/qnamespace.qdoc
+++ b/doc/src/qnamespace.qdoc
@@ -1246,8 +1246,9 @@
/*! \typedef Qt::HANDLE
Platform-specific handle type for system objects. This is
- equivalent to \c{void *} on Windows and Mac OS X, and embedded
- Linux, and to \c{unsigned long} on X11.
+ equivalent to \c{void *} on Mac OS X and embedded Linux,
+ and to \c{unsigned long} on X11. On Windows it is the
+ DWORD returned by the Win32 function getCurrentThreadId().
\warning Using this type is not portable.
*/
diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp
index 24522f2..2e31c6d 100644
--- a/src/corelib/thread/qthread.cpp
+++ b/src/corelib/thread/qthread.cpp
@@ -261,9 +261,14 @@ void QAdoptedThread::run()
Returns the thread handle of the currently executing thread.
\warning The handle returned by this function is used for internal
- purposes and should not be used in any application code. On
- Windows, the returned value is a pseudo-handle for the current
- thread that cannot be used for numerical comparison.
+ purposes and should not be used in any application code.
+
+ \warning On Windows, the returned value is a pseudo-handle for the
+ current thread. It can't be used for numerical comparison. i.e.,
+ this function returns the DWORD (Windows-Thread ID) returned by
+ the Win32 function getCurrentThreadId(), not the HANDLE
+ (Windows-Thread HANDLE) returned by the Win32 function
+ getCurrentThread().
*/
/*!