usr/src/man/man3c/_longjmp.3c

   1 '\" te
   2 .\" Copyright (c) 1994, X/Open Company Limited.  All Rights Reserved.
   3 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH _LONGJMP 3C "Jul 24, 2002"
  12 .SH NAME
  13 _longjmp, _setjmp \- non-local goto
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <setjmp.h>
  18
  19 \fBvoid\fR \fB_longjmp\fR(\fBjmp_buf\fR \fIenv\fR, \fBint\fR \fIval\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fB_setjmp\fR(\fBjmp_buf\fR \fIenv\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fB_longjmp()\fR and \fB_setjmp()\fR functions are identical to
  31 \fBlongjmp\fR(3C) and \fBsetjmp\fR(3C), respectively, with the additional
  32 restriction that \fB_longjmp()\fR and \fB_setjmp()\fR do not manipulate the
  33 signal mask.
  34 .sp
  35 .LP
  36 If \fB_longjmp()\fR is called even though \fBenv\fR was never initialized by a
  37 call to \fB_setjmp()\fR, or when the last such call was in a function that has
  38 since returned, the results are undefined.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 Refer to \fBlongjmp\fR(3C) and \fBsetjmp\fR(3C).
  43 .SH ERRORS
  44 .sp
  45 .LP
  46 No errors are defined.
  47 .SH USAGE
  48 .sp
  49 .LP
  50 If \fB_longjmp()\fR is executed and the environment in which \fB_setjmp()\fR
  51 was executed no longer exists, errors can occur. The conditions under which the
  52 environment of the \fB_setjmp()\fR no longer exists include exiting the
  53 function that contains the \fB_setjmp()\fR call, and exiting an inner block
  54 with temporary storage. This condition might not be detectable, in which case
  55 the \fB_longjmp()\fR occurs and, if the environment no longer exists, the
  56 contents of the temporary storage of an inner block are unpredictable. This
  57 condition might also cause unexpected process termination. If the function has
  58 returned, the results are undefined.
  59 .sp
  60 .LP
  61 Passing \fBlongjmp()\fR a pointer to a buffer not created by \fBsetjmp(\|),\fR
  62 passing \fB_longjmp()\fR a pointer to a buffer not created by \fB_setjmp()\fR,
  63 passing \fBsiglongjmp\fR(3C) a pointer to a buffer not created by
  64 \fBsigsetjmp\fR(3C) or passing any of these three functions a buffer that has
  65 been modified by the user can cause all the problems listed above, and more.
  66 .sp
  67 .LP
  68 The \fB_longjmp()\fR and \fB_setjmp()\fR functions are included to support
  69 programs written to historical system interfaces.  New applications should use
  70 \fBsiglongjmp\fR(3C) and \fBsigsetjmp\fR(3C) respectively.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Interface Stability     Standard
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBlongjmp\fR(3C), \fBsetjmp\fR(3C), \fBsiglongjmp\fR(3C), \fBsigsetjmp\fR(3C),
  91 \fBattributes\fR(5), \fBstandards\fR(5)