luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-24 01:48:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

gwin32: Reformat documentation for g_win32_error_message()

Browse Source 
Port it to gi-docgen format and improve it to match the documentation
style guide.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3740
This commit is contained in:
Philip Withnall
2025-07-25 10:21:04 +01:00
parent 6a399d740a
commit 764aaae391
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
glib/gwin32.c
View File

@@ -194,16 +194,20 @@ g_win32_getlocale (void)
/**
* g_win32_error_message:
* @error: error code.
* @error: Win32 error code
*
* Translate a Win32 error code (as returned by GetLastError() or
* WSAGetLastError()) into the corresponding message. The message is
* either language neutral, or in the thread's language, or the user's
* language, the system's language, or US English (see docs for
* FormatMessage()). The returned string is in UTF-8. It should be
* deallocated with g_free().
* Translate a Win32 error code into a human readable message.
*
* Returns: newly-allocated error message
* The error code could be as returned by
* [`GetLastError()`](https://learn.microsoft.com/en-us/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
* or [`WSAGetLastError()`](https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-wsagetlasterror).
*
* The message is either language neutral, or in the thread’s language, or the
* user’s language, the system’s language, or US English (see documentation for
* [`FormatMessage()`](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessagew)).
* The returned string is in UTF-8.
*
* Returns: (transfer full) (not nullable): newly-allocated error message
**/
gchar *
g_win32_error_message (gint error)