Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/setjmp.html
2024-02-19 00:21:47 -05:00

150 lines
5.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>setjmp</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="setjmp"></a> <a name="tag_03_653"></a><!-- setjmp -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_653_01"></a>NAME</h4>
<blockquote>setjmp - set jump point for a non-local goto</blockquote>
<h4><a name="tag_03_653_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/setjmp.h.html">setjmp.h</a>&gt;<br>
<br>
int setjmp(jmp_buf</tt> <i>env</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_653_03"></a>DESCRIPTION</h4>
<blockquote>
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
border="0"> The functionality described on this reference page is aligned with the ISO&nbsp;C standard. Any conflict between the
requirements described here and the ISO&nbsp;C standard is unintentional. This volume of IEEE&nbsp;Std&nbsp;1003.1-2001 defers to
the ISO&nbsp;C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
<p>A call to <i>setjmp</i>() shall save the calling environment in its <i>env</i> argument for later use by <a href=
"../functions/longjmp.html"><i>longjmp</i>()</a>.</p>
<p>It is unspecified whether <i>setjmp</i>() is a macro or a function. If a macro definition is suppressed in order to access an
actual function, or a program defines an external identifier with the name <i>setjmp</i>, the behavior is undefined.</p>
<p>An application shall ensure that an invocation of <i>setjmp</i>() appears in one of the following contexts only:</p>
<ul>
<li>
<p>The entire controlling expression of a selection or iteration statement</p>
</li>
<li>
<p>One operand of a relational or equality operator with the other operand an integral constant expression, with the resulting
expression being the entire controlling expression of a selection or iteration statement</p>
</li>
<li>
<p>The operand of a unary <tt>'!'</tt> operator with the resulting expression being the entire controlling expression of a
selection or iteration</p>
</li>
<li>
<p>The entire expression of an expression statement (possibly cast to <b>void</b>)</p>
</li>
</ul>
<p>If the invocation appears in any other context, the behavior is undefined.</p>
</blockquote>
<h4><a name="tag_03_653_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If the return is from a direct invocation, <i>setjmp</i>() shall return 0. If the return is from a call to <a href=
"../functions/longjmp.html"><i>longjmp</i>()</a>, <i>setjmp</i>() shall return a non-zero value.</p>
</blockquote>
<h4><a name="tag_03_653_05"></a>ERRORS</h4>
<blockquote>
<p>No errors are defined.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_653_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_653_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>In general, <a href="../functions/sigsetjmp.html"><i>sigsetjmp</i>()</a> is more useful in dealing with errors and interrupts
encountered in a low-level subroutine of a program.</p>
</blockquote>
<h4><a name="tag_03_653_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_653_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_653_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="longjmp.html"><i>longjmp</i>()</a> , <a href="sigsetjmp.html"><i>sigsetjmp</i>()</a> , the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/setjmp.h.html"><i>&lt;setjmp.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_653_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 1. Derived from Issue 1 of the SVID.</p>
</blockquote>
<h4><a name="tag_03_653_12"></a>Issue 6</h4>
<blockquote>
<p>The DESCRIPTION is updated to avoid use of the term &quot;must&quot; for application requirements.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>