diff options
| author | Mike Kaganski <mike.kaganski@collabora.com> | 2017-11-02 13:22:41 +0300 |
|---|---|---|
| committer | Mike Kaganski <mike.kaganski@collabora.com> | 2017-11-04 15:24:32 +0100 |
| commit | e3530d2c9d5dc98c6bacf243c163d651624e1ba6 (patch) | |
| tree | e9f124596df0c4b2a3e345a3b58f67d4563aae24 /include/comphelper | |
| parent | fce7a0b3606f216f68a0f2e3591182c4358b88ff (diff) | |
Make Windows error reporting more robust
https://msdn.microsoft.com/en-us/library/ms679351 describes that
"it is unsafe to take an arbitrary system error code returned from an API
and use FORMAT_MESSAGE_FROM_SYSTEM without FORMAT_MESSAGE_IGNORE_INSERTS"
Previously in case when an error string would contain inserts, function
returned error, so the error message wasn't shown (at least it didn't
crash, thanks to nullptr as the function's last argument).
As the function may fail, we now pre-nullify the buffer pointer to avoid
dereferencing uninitialized pointer later (though at least for some
Windows versions, the function nullifies the pointer in case of
FORMAT_MESSAGE_ALLOCATE_BUFFER, but there's no explicit guarantee of this).
Also release of allocated buffer is changed to recommended use of
HeapFree.
The code that doesn't make use of OUString is left directly calling
FormatMessage, to avoid introducing new dependencies. Where it makes
sense, we now use WindowsErrorString from <comphelper/windowserrorstring.hxx>
Change-Id: I834c08eb6d92987e7d3d01e2c36ec55e42aea848
Reviewed-on: https://gerrit.libreoffice.org/44206
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Diffstat (limited to 'include/comphelper')
| -rw-r--r-- | include/comphelper/windowserrorstring.hxx | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/comphelper/windowserrorstring.hxx b/include/comphelper/windowserrorstring.hxx index bb4b16241ca5..1b50f1eadb58 100644 --- a/include/comphelper/windowserrorstring.hxx +++ b/include/comphelper/windowserrorstring.hxx @@ -21,7 +21,7 @@ inline OUString WindowsErrorString(DWORD nErrorCode) { LPWSTR pMsgBuf; - if (FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, + if (FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr, nErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), @@ -33,7 +33,7 @@ inline OUString WindowsErrorString(DWORD nErrorCode) OUString result(o3tl::toU(pMsgBuf)); result.endsWith("\r\n", &result); - LocalFree(pMsgBuf); + HeapFree(GetProcessHeap(), 0, pMsgBuf); return result; } |