logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

timer_delete.3p (2730B)

    

  1. '\" et
  2. .TH TIMER_DELETE "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. timer_delete
  12. \(em delete a per-process timer
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <time.h>
  17. .P
  18. int timer_delete(timer_t \fItimerid\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fItimer_delete\fR()
  23. function deletes the specified timer,
  24. .IR timerid ,
  25. previously created by the
  26. \fItimer_create\fR()
  27. function. If the timer is armed when
  28. \fItimer_delete\fR()
  29. is called, the behavior shall be as if the timer is automatically
  30. disarmed before removal. The disposition of pending signals for the
  31. deleted timer is unspecified.
  32. .P
  33. The behavior is undefined if the value specified by the
  34. .IR timerid
  35. argument to
  36. \fItimer_delete\fR()
  37. does not correspond to a timer ID returned by
  38. \fItimer_create\fR()
  39. but not yet deleted by
  40. \fItimer_delete\fR().
  41. .SH "RETURN VALUE"
  42. If successful, the
  43. \fItimer_delete\fR()
  44. function shall return a value of zero. Otherwise, the function shall
  45. return a value of \-1 and set
  46. .IR errno
  47. to indicate the error.
  48. .SH ERRORS
  49. No errors are defined.
  50. .LP
  51. .IR "The following sections are informative."
  52. .SH EXAMPLES
  53. None.
  54. .SH "APPLICATION USAGE"
  55. None.
  56. .SH RATIONALE
  57. If an implementation detects that the value specified by the
  58. .IR timerid
  59. argument to
  60. \fItimer_delete\fR()
  61. does not correspond to a timer ID returned by
  62. \fItimer_create\fR()
  63. but not yet deleted by
  64. \fItimer_delete\fR(),
  65. it is recommended that the function should fail and report an
  66. .BR [EINVAL] 
  67. error.
  68. .SH "FUTURE DIRECTIONS"
  69. None.
  70. .SH "SEE ALSO"
  71. .IR "\fItimer_create\fR\^(\|)"
  72. .P
  73. The Base Definitions volume of POSIX.1\(hy2017,
  74. .IR "\fB<time.h>\fP"
  75. .\"
  76. .SH COPYRIGHT
  77. Portions of this text are reprinted and reproduced in electronic form
  78. from IEEE Std 1003.1-2017, Standard for Information Technology
  79. -- Portable Operating System Interface (POSIX), The Open Group Base
  80. Specifications Issue 7, 2018 Edition,
  81. Copyright (C) 2018 by the Institute of
  82. Electrical and Electronics Engineers, Inc and The Open Group.
  83. In the event of any discrepancy between this version and the original IEEE and
  84. The Open Group Standard, the original IEEE and The Open Group Standard
  85. is the referee document. The original Standard can be obtained online at
  86. http://www.opengroup.org/unix/online.html .
  87. .PP
  88. Any typographical or formatting errors that appear
  89. in this page are most likely
  90. to have been introduced during the conversion of the source files to
  91. man page format. To report such errors, see
  92. https://www.kernel.org/doc/man-pages/reporting_bugs.html .