Commit 326ade76 authored by Victor Zverovich's avatar Victor Zverovich

Document what happens if you pass an invalid error code

to SystemError or WindowsError
parent 502d2ede
...@@ -1427,6 +1427,8 @@ class SystemError : public internal::RuntimeError { ...@@ -1427,6 +1427,8 @@ class SystemError : public internal::RuntimeError {
where *<message>* is the formatted message and *<system-message>* is where *<message>* is the formatted message and *<system-message>* is
the system message corresponding to the error code. the system message corresponding to the error code.
*error_code* is a system error code as given by ``errno``. *error_code* is a system error code as given by ``errno``.
If *error_code* is not a valid error code such as -1, the system message
may look like "Unknown error -1" and is platform-dependent.
**Example**:: **Example**::
...@@ -2109,9 +2111,7 @@ void report_system_error(int error_code, StringRef message) FMT_NOEXCEPT(true); ...@@ -2109,9 +2111,7 @@ void report_system_error(int error_code, StringRef message) FMT_NOEXCEPT(true);
#ifdef _WIN32 #ifdef _WIN32
/** /** A Windows error. */
A Windows error.
*/
class WindowsError : public SystemError { class WindowsError : public SystemError {
private: private:
void init(int error_code, StringRef format_str, ArgList args); void init(int error_code, StringRef format_str, ArgList args);
...@@ -2127,6 +2127,8 @@ class WindowsError : public SystemError { ...@@ -2127,6 +2127,8 @@ class WindowsError : public SystemError {
where *<message>* is the formatted message and *<system-message>* is the system where *<message>* is the formatted message and *<system-message>* is the system
message corresponding to the error code. message corresponding to the error code.
*error_code* is a Windows error code as given by ``GetLastError``. *error_code* is a Windows error code as given by ``GetLastError``.
If *error_code* is not a valid error code such as -1, the system message
will look like "error -1".
**Example**:: **Example**::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment