Correctly document value of QThread::currentThreadId on Windows

The implementation calls GetCurrentThreadId, not GetCurrentThread, so
the return value is not the pseudo-handle.

Task-number: QTBUG-67686
Change-Id: Ifde0cf603dcea01bc1c454a8bebe1e5c0f22617f
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Volker Hilsheimer 2018-10-26 15:32:50 +00:00 committed by Jani Heikkinen
parent e14e8427fa
commit 3f61873f49

View File

@ -298,12 +298,9 @@ QThreadPrivate::~QThreadPrivate()
\warning The handle returned by this function is used for internal
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().
\note On Windows, this function returns the DWORD (Windows-Thread
ID) returned by the Win32 function GetCurrentThreadId(), not the pseudo-HANDLE
(Windows-Thread HANDLE) returned by the Win32 function GetCurrentThread().
*/
/*!