diff options
| author | dgp <dgp@noemail.net> | 2002-01-15 21:47:27 (GMT) |
|---|---|---|
| committer | dgp <dgp@noemail.net> | 2002-01-15 21:47:27 (GMT) |
| commit | c90abd145f947ecc2b1ec59e7b104d2e049bcb8b (patch) | |
| tree | 28f96fb27d3053915f14b3f5245cab6db984fef1 /doc | |
| parent | 328999cb9dcaac2de7b3e304807abfda6e5d815a (diff) | |
| download | tcl-c90abd145f947ecc2b1ec59e7b104d2e049bcb8b.zip tcl-c90abd145f947ecc2b1ec59e7b104d2e049bcb8b.tar.gz tcl-c90abd145f947ecc2b1ec59e7b104d2e049bcb8b.tar.bz2 | |
* Corrected documentation for Tcl_ErrnoMsg; it takes an integer
argument. Thanks to Georgios Petasis. [Bug 468183]
FossilOrigin-Name: d2700a215723c1a95a37fb229c104e620f902fe8
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/SetErrno.3 | 18 |
1 files changed, 11 insertions, 7 deletions
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 |