[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / man / man3 / Tcl_SetErrno.3

'\"
'\" Copyright (c) 1996 Sun Microsystems, Inc.
'\"
'\" 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.5 2002/01/15 21:47:27 dgp Exp $
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg \- manipulate errno to store and retrieve error codes
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
void
\fBTcl_SetErrno\fR(\fIerrorCode\fR)
.sp
int
\fBTcl_GetErrno\fR()
.sp
CONST char *
\fBTcl_ErrnoId\fR()
.sp
CONST char *
\fBTcl_ErrnoMsg\fR(\fIerrorCode\fR)
.sp
.SH ARGUMENTS
.AS int errorCode in
.AP int errorCode in
A POSIX error code such as \fBENOENT\fR.
.BE

.SH DESCRIPTION
.PP
\fBTcl_SetErrno\fR and \fBTcl_GetErrno\fR provide portable access
to the \fBerrno\fR variable, which is used to record a POSIX error
code after system calls and other operations such as \fBTcl_Gets\fR.
These procedures are necessary because global variable accesses cannot
be made across module boundaries on some platforms.
.PP
\fBTcl_SetErrno\fR sets the \fBerrno\fR variable to the value of the
\fIerrorCode\fR argument
C procedures that wish to return error information to their callers
via \fBerrno\fR should call \fBTcl_SetErrno\fR rather than setting
\fBerrno\fR directly.
.PP
\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 string
representations of \fBerrno\fR values.  \fBTcl_ErrnoId\fR
returns a machine-readable textual identifier such as
"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
errno, error code, global variables
Commit	Line	Data
86530b38 AT	1	'\"
	2	'\" Copyright (c) 1996 Sun Microsystems, Inc.
	3	'\"
	4	'\" See the file "license.terms" for information on usage and redistribution
	5	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	6	'\"
	7	'\" RCS: @(#) $Id: SetErrno.3,v 1.5 2002/01/15 21:47:27 dgp Exp $
	8	'\" The definitions below are for supplemental macros used in Tcl/Tk
	9	'\" manual entries.
	10	'\"
	11	'\" .AP type name in/out ?indent?
	12	'\" Start paragraph describing an argument to a library procedure.
	13	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	14	'\" or "in/out" to describe whether procedure reads or modifies arg,
	15	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	16	'\" needed; use .AS below instead)
	17	'\"
	18	'\" .AS ?type? ?name?
	19	'\" Give maximum sizes of arguments for setting tab stops. Type and
	20	'\" name are examples of largest possible arguments that will be passed
	21	'\" to .AP later. If args are omitted, default tab stops are used.
	22	'\"
	23	'\" .BS
	24	'\" Start box enclosure. From here until next .BE, everything will be
	25	'\" enclosed in one large box.
	26	'\"
	27	'\" .BE
	28	'\" End of box enclosure.
	29	'\"
	30	'\" .CS
	31	'\" Begin code excerpt.
	32	'\"
	33	'\" .CE
	34	'\" End code excerpt.
	35	'\"
	36	'\" .VS ?version? ?br?
	37	'\" Begin vertical sidebar, for use in marking newly-changed parts
	38	'\" of man pages. The first argument is ignored and used for recording
	39	'\" the version when the .VS was added, so that the sidebars can be
	40	'\" found and removed when they reach a certain age. If another argument
	41	'\" is present, then a line break is forced before starting the sidebar.
	42	'\"
	43	'\" .VE
	44	'\" End of vertical sidebar.
	45	'\"
	46	'\" .DS
	47	'\" Begin an indented unfilled display.
	48	'\"
	49	'\" .DE
	50	'\" End of indented unfilled display.
	51	'\"
	52	'\" .SO
	53	'\" Start of list of standard options for a Tk widget. The
	54	'\" options follow on successive lines, in four columns separated
	55	'\" by tabs.
	56	'\"
	57	'\" .SE
	58	'\" End of list of standard options for a Tk widget.
	59	'\"
	60	'\" .OP cmdName dbName dbClass
	61	'\" Start of description of a specific option. cmdName gives the
	62	'\" option's name as specified in the class command, dbName gives
	63	'\" the option's name in the option database, and dbClass gives
	64	'\" the option's class in the option database.
65	'\"
66	'\" .UL arg1 arg2
67	'\" Print arg1 underlined, then print arg2 normally.
68	'\"
69	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
70	'\"
71	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
72	.if t .wh -1.3i ^B
73	.nr ^l \n(.l
74	.ad b
75	'\" # Start an argument description
76	.de AP
77	.ie !"\\$4"" .TP \\$4
78	.el \{\
79	. ie !"\\$2"" .TP \\n()Cu
80	. el .TP 15
81	.\}
82	.ta \\n()Au \\n()Bu
83	.ie !"\\$3"" \{\
84	\&\\$1 \\fI\\$2\\fP (\\$3)
85	.\".b
86	.\}
87	.el \{\
88	.br
89	.ie !"\\$2"" \{\
90	\&\\$1 \\fI\\$2\\fP
91	.\}
92	.el \{\
93	\&\\fI\\$1\\fP
94	.\}
95	.\}
96	..
97	'\" # define tabbing values for .AP
98	.de AS
99	.nr )A 10n
100	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
101	.nr )B \\n()Au+15n
102	.\"
103	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
104	.nr )C \\n()Bu+\\w'(in/out)'u+2n
105	..
106	.AS Tcl_Interp Tcl_CreateInterp in/out
107	'\" # BS - start boxed text
108	'\" # ^y = starting y location
109	'\" # ^b = 1
110	.de BS
111	.br
112	.mk ^y
113	.nr ^b 1u
114	.if n .nf
115	.if n .ti 0
116	.if n \l'\\n(.lu\(ul'
117	.if n .fi
118	..
119	'\" # BE - end boxed text (draw box now)
120	.de BE
121	.nf
122	.ti 0
123	.mk ^t
124	.ie n \l'\\n(^lu\(ul'
125	.el \{\
126	.\" Draw four-sided box normally, but don't draw top of
127	.\" box if the box started on an earlier page.
128	.ie !\\n(^b-1 \{\
129	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
130	.\}
131	.el \}\
132	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
133	.\}
134	.\}
135	.fi
136	.br
137	.nr ^b 0
138	..
139	'\" # VS - start vertical sidebar
140	'\" # ^Y = starting y location
141	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
142	.de VS
143	.if !"\\$2"" .br
144	.mk ^Y
145	.ie n 'mc \s12\(br\s0
146	.el .nr ^v 1u
147	..
148	'\" # VE - end of vertical sidebar
149	.de VE
150	.ie n 'mc
151	.el \{\
152	.ev 2
153	.nf
154	.ti 0
155	.mk ^t
156	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
157	.sp -1
158	.fi
159	.ev
160	.\}
161	.nr ^v 0
162	..
163	'\" # Special macro to handle page bottom: finish off current
164	'\" # box/sidebar if in box/sidebar mode, then invoked standard
165	'\" # page bottom macro.
166	.de ^B
167	.ev 2
168	'ti 0
169	'nf
170	.mk ^t
171	.if \\n(^b \{\
172	.\" Draw three-sided box if this is the box's first page,
173	.\" draw two sides but no top otherwise.
174	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
175	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
176	.\}
177	.if \\n(^v \{\
178	.nr ^x \\n(^tu+1v-\\n(^Yu
179	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
180	.\}
181	.bp
182	'fi
183	.ev
184	.if \\n(^b \{\
185	.mk ^y
186	.nr ^b 2
187	.\}
188	.if \\n(^v \{\
189	.mk ^Y
190	.\}
191	..
192	'\" # DS - begin display
193	.de DS
194	.RS
195	.nf
196	.sp
197	..
198	'\" # DE - end display
199	.de DE
200	.fi
201	.RE
202	.sp
203	..
204	'\" # SO - start of list of standard options
205	.de SO
206	.SH "STANDARD OPTIONS"
207	.LP
208	.nf
209	.ta 5.5c 11c
210	.ft B
211	..
212	'\" # SE - end of list of standard options
213	.de SE
214	.fi
215	.ft R
216	.LP
217	See the \\fBoptions\\fR manual entry for details on the standard options.
218	..
219	'\" # OP - start of full description for a single option
220	.de OP
221	.LP
222	.nf
223	.ta 4c
224	Command-Line Name: \\fB\\$1\\fR
225	Database Name: \\fB\\$2\\fR
226	Database Class: \\fB\\$3\\fR
227	.fi
228	.IP
229	..
230	'\" # CS - begin code excerpt
231	.de CS
232	.RS
233	.nf
234	.ta .25i .5i .75i 1i
235	..
236	'\" # CE - end code excerpt
237	.de CE
238	.fi
239	.RE
240	..
241	.de UL
242	\\$1\l'\|0\(ul'\\$2
243	..
244	.TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures"
245	.BS
246	.SH NAME
247	Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg \- manipulate errno to store and retrieve error codes
248	.SH SYNOPSIS
249	.nf
250	\fB#include <tcl.h>\fR
251	.sp
252	void
253	\fBTcl_SetErrno\fR(\fIerrorCode\fR)
254	.sp
255	int
256	\fBTcl_GetErrno\fR()
257	.sp
258	CONST char *
259	\fBTcl_ErrnoId\fR()
260	.sp
261	CONST char *
262	\fBTcl_ErrnoMsg\fR(\fIerrorCode\fR)
263	.sp
264	.SH ARGUMENTS
265	.AS int errorCode in
266	.AP int errorCode in
267	A POSIX error code such as \fBENOENT\fR.
268	.BE
269
270	.SH DESCRIPTION
271	.PP
272	\fBTcl_SetErrno\fR and \fBTcl_GetErrno\fR provide portable access
273	to the \fBerrno\fR variable, which is used to record a POSIX error
274	code after system calls and other operations such as \fBTcl_Gets\fR.
275	These procedures are necessary because global variable accesses cannot
276	be made across module boundaries on some platforms.
277	.PP
278	\fBTcl_SetErrno\fR sets the \fBerrno\fR variable to the value of the
279	\fIerrorCode\fR argument
280	C procedures that wish to return error information to their callers
281	via \fBerrno\fR should call \fBTcl_SetErrno\fR rather than setting
282	\fBerrno\fR directly.
283	.PP
284	\fBTcl_GetErrno\fR returns the current value of \fBerrno\fR.
285	Procedures wishing to access \fBerrno\fR should call this procedure
286	instead of accessing \fBerrno\fR directly.
287	.PP
288	\fBTcl_ErrnoId\fR and \fBTcl_ErrnoMsg\fR return string
289	representations of \fBerrno\fR values. \fBTcl_ErrnoId\fR
290	returns a machine-readable textual identifier such as
291	"EACCES" that corresponds to the current value of \fBerrno\fR.
292	\fBTcl_ErrnoMsg\fR returns a human-readable string such as
293	"permission denied" that corresponds to the value of its
294	\fIerrorCode\fR argument. The \fIerrorCode\fR argument is
295	typically the value returned by \fBTcl_GetErrno\fR.
296	The strings returned by these functions are
297	statically allocated and the caller must not free or modify them.
298
299	.SH KEYWORDS
300	errno, error code, global variables