summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2002-01-15 21:47:27 (GMT)
committerdgp <dgp@users.sourceforge.net>2002-01-15 21:47:27 (GMT)
commit14ca3bb7f42dde3399d6968c2c62597320f9a9dc (patch)
tree28f96fb27d3053915f14b3f5245cab6db984fef1
parent1f65844631f74a8dfd9e7ed208564f50f401b3c9 (diff)
downloadtcl-14ca3bb7f42dde3399d6968c2c62597320f9a9dc.zip
tcl-14ca3bb7f42dde3399d6968c2c62597320f9a9dc.tar.gz
tcl-14ca3bb7f42dde3399d6968c2c62597320f9a9dc.tar.bz2
* Corrected documentation for Tcl_ErrnoMsg; it takes an integer
argument. Thanks to Georgios Petasis. [Bug 468183]
-rw-r--r--ChangeLog4
-rw-r--r--doc/SetErrno.318
2 files changed, 15 insertions, 7 deletions
diff --git a/ChangeLog b/ChangeLog
index bb1e525..1bb5940 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2002-01-15 Don Porter <dgp@users.sourceforge.net>
+ * doc/SetErrno.3 (Tcl_ErrnoMsg): Corrected documentation for
+ Tcl_ErrnoMsg; it takes an integer argument. Thanks to Georgios
+ Petasis. [Bug 468183]
+
* doc/AddErrInfo.3 (Tcl_PosixError):
* doc/Eval.3 (Tcl_EvalFile):
* doc/FileSystem.c (Tcl_FSOpenFileChannel,Tcl_FSOpenFileChannelProc):
diff --git a/doc/SetErrno.3 b/doc/SetErrno.3
index 2625c9a..d8eb1c1 100644
--- a/doc/SetErrno.3
+++ b/doc/SetErrno.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: SetErrno.3,v 1.4 2002/01/15 21:19:06 dgp Exp $
+'\" RCS: @(#) $Id: SetErrno.3,v 1.5 2002/01/15 21:47:27 dgp Exp $
.so man.macros
.TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures"
.BS
@@ -24,10 +24,10 @@ CONST char *
\fBTcl_ErrnoId\fR()
.sp
CONST char *
-\fBTcl_ErrnoMsg\fR()
+\fBTcl_ErrnoMsg\fR(\fIerrorCode\fR)
.sp
.SH ARGUMENTS
-.AS Tcl_Interp *errorCode in
+.AS int errorCode in
.AP int errorCode in
A POSIX error code such as \fBENOENT\fR.
.BE
@@ -50,11 +50,15 @@ via \fBerrno\fR should call \fBTcl_SetErrno\fR rather than setting
Procedures wishing to access \fBerrno\fR should call this procedure
instead of accessing \fBerrno\fR directly.
.PP
-\fBTcl_ErrnoId\fR and \fBTcl_ErrnoMsg\fR return a string
-representation of the current \fBerrno\fR value. \fBTcl_ErrnoId\fR
+\fBTcl_ErrnoId\fR and \fBTcl_ErrnoMsg\fR return string
+representations of \fBerrno\fR values. \fBTcl_ErrnoId\fR
returns a machine-readable textual identifier such as
-"EACCES". \fBTcl_ErrnoMsg\fR returns a human-readable string such as
-"permission denied". The strings returned by these functions are
+"EACCES" that corresponds to the current value of \fBerrno\fR.
+\fBTcl_ErrnoMsg\fR returns a human-readable string such as
+"permission denied" that corresponds to the value of its
+\fIerrorCode\fR argument. The \fIerrorCode\fR argument is
+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.
.SH KEYWORDS