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

130 lines
4.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>timer_delete</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="timer_delete"></a> <a name="tag_03_777"></a><!-- timer_delete -->
<!--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_777_01"></a>NAME</h4>
<blockquote>timer_delete - delete a per-process timer (<b>REALTIME</b>)</blockquote>
<h4><a name="tag_03_777_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('TMR')">TMR</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/time.h.html">time.h</a>&gt;<br>
<br>
int timer_delete(timer_t</tt> <i>timerid</i><tt>); <img src="../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_777_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>timer_delete</i>() function deletes the specified timer, <i>timerid</i>, previously created by the <a href=
"../functions/timer_create.html"><i>timer_create</i>()</a> function. If the timer is armed when <i>timer_delete</i>() is called,
the behavior shall be as if the timer is automatically disarmed before removal. The disposition of pending signals for the deleted
timer is unspecified.</p>
</blockquote>
<h4><a name="tag_03_777_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If successful, the <i>timer_delete</i>() function shall return a value of zero. Otherwise, the function shall return a value of
-1 and set <i>errno</i> to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_777_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>timer_delete</i>() function shall fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The timer ID specified by <i>timerid</i> is not a valid timer ID.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_777_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_777_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_777_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_777_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_777_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="timer_create.html"><i>timer_create</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/time.h.html"><i>&lt;time.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_777_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 5. Included for alignment with the POSIX Realtime Extension.</p>
</blockquote>
<h4><a name="tag_03_777_12"></a>Issue 6</h4>
<blockquote>
<p>The <i>timer_delete</i>() function is marked as part of the Timers option.</p>
<p>The [ENOSYS] error condition has been removed as stubs need not be provided if an implementation does not support the Timers
option.</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>