diff options
| author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2024-04-12 21:40:07 (GMT) |
|---|---|---|
| committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2024-04-12 21:40:07 (GMT) |
| commit | 42dcfe9f62c31bcf0543c3c1b3316fc28543f6e9 (patch) | |
| tree | 933500cc39909d7687e92a84c303566df9ac41df | |
| parent | f1d98185ed272bf66273010cf052cc5cbfeab625 (diff) | |
| download | tcl-42dcfe9f62c31bcf0543c3c1b3316fc28543f6e9.zip tcl-42dcfe9f62c31bcf0543c3c1b3316fc28543f6e9.tar.gz tcl-42dcfe9f62c31bcf0543c3c1b3316fc28543f6e9.tar.bz2 | |
Add missing documentation for TIP 598 Tcl_WinConvertError
| -rw-r--r-- | doc/SetErrno.3 | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/SetErrno.3 b/doc/SetErrno.3 index c202e2e..84d7553 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 <tcl.h>\fR @@ -25,10 +25,16 @@ const char * 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 @@ -61,6 +67,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 |