mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-11-08 11:33:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document what happens if you pass an invalid error code

Browse Source 
to SystemError or WindowsError
This commit is contained in:
Victor Zverovich 2015-02-07 09:46:42 -08:00
parent 502d2ede8a
commit 326ade7698
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
format.h
View File

@ -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);
#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,7 +2127,9 @@ 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**::
// This throws a WindowsError with the description // This throws a WindowsError with the description