summaryrefslogtreecommitdiffstats
path: root/doc/SetErrno.3
diff options
context:
space:
mode:
authorericm <ericm>2000-01-26 21:36:35 (GMT)
committerericm <ericm>2000-01-26 21:36:35 (GMT)
commitd3256a88c6ade958ce2e87ca8a3b7c0231e476ef (patch)
treec034dc441d7fe54e8a3187e41a118ac3a83186fd /doc/SetErrno.3
parent7b6b3a5c4a1ea767c7ba8cb5236f916461e703b9 (diff)
downloadtcl-d3256a88c6ade958ce2e87ca8a3b7c0231e476ef.zip
tcl-d3256a88c6ade958ce2e87ca8a3b7c0231e476ef.tar.gz
tcl-d3256a88c6ade958ce2e87ca8a3b7c0231e476ef.tar.bz2
* generic/tclNamesp.c: Undid fix for #956, which broke backwards
compatibility. * doc/variable.n: * doc/trace.n: * doc/namespace.n: * doc/info.n: Added further information about differences between "namespace which" and "info exists". * doc/SetErrno.3: Added descriptions of ErrnoId() and ErrnoMsg() functions.
Diffstat (limited to 'doc/SetErrno.3')
-rw-r--r--doc/SetErrno.319
1 files changed, 16 insertions, 3 deletions
diff --git a/doc/SetErrno.3 b/doc/SetErrno.3
index d57263b..78adebd 100644
--- a/doc/SetErrno.3
+++ b/doc/SetErrno.3
@@ -4,12 +4,12 @@
'\" 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.2 1998/09/14 18:39:50 stanton Exp $
+'\" RCS: @(#) $Id: SetErrno.3,v 1.3 2000/01/26 21:36:35 ericm Exp $
.so man.macros
-.TH Tcl_SetErrno 3 7.5 Tcl "Tcl Library Procedures"
+.TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures"
.BS
.SH NAME
-Tcl_SetErrno, Tcl_GetErrno \- manipulate errno to store and retrieve error codes
+Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg \- manipulate errno to store and retrieve error codes
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -20,6 +20,12 @@ void
int
\fBTcl_GetErrno\fR()
.sp
+char *
+\fBTcl_ErrnoId\fR()
+.sp
+char *
+\fBTcl_ErrnoMsg\fR()
+.sp
.SH ARGUMENTS
.AS Tcl_Interp *errorCode in
.AP int errorCode in
@@ -43,6 +49,13 @@ via \fBerrno\fR should call \fBTcl_SetErrno\fR rather than setting
\fBTcl_GetErrno\fR returns the current value of \fBerrno\fR.
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
+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
+statically allocated and the caller must not free or modify them.
.SH KEYWORDS
errno, error code, global variables