From 104ed642d8bffb3165f77e197e1e46b72e4d9c82 Mon Sep 17 00:00:00 2001 From: apnadkarni Date: Fri, 12 Apr 2024 17:15:54 +0000 Subject: Add missing documentation for TIP 598 Tcl_WinConvertError --- doc/SetErrno.3 | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/SetErrno.3 b/doc/SetErrno.3 index abed74e..877a362 100644 --- a/doc/SetErrno.3 +++ b/doc/SetErrno.3 @@ -8,7 +8,7 @@ .so man.macros .BS .SH NAME -Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg \- manipulate errno to store and retrieve error codes +Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg, Tcl_WinConvertError \- manipulate errno to store and retrieve error codes .SH SYNOPSIS .nf \fB#include \fR @@ -23,11 +23,17 @@ const char * .sp const char * \fBTcl_ErrnoMsg\fR(\fIerrorCode\fR) +.sp +void +\fBTcl_WinConvertError\fR(\fIwinErrorCode\fR) .fi .SH ARGUMENTS .AS int errorCode .AP int errorCode in A POSIX error code such as \fBENOENT\fR. +.AS unsigned int winErrorCode in +.AP DWORD winErrorCode in +A Windows or Winsock error code such as \fBERROR_FILE_NOT_FOUND\fR. .BE .SH DESCRIPTION @@ -60,6 +66,9 @@ that corresponds to the value of its typically the value returned by \fBTcl_GetErrno\fR. The strings returned by these functions are statically allocated and the caller must not free or modify them. +.PP +\fBTcl_WinConvertError\fR (Windows only) maps the passed Windows or Winsock +error code to a POSIX error and stores it in \fBerrno\fR. .SH KEYWORDS errno, error code, global variables -- cgit v0.12