projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
| 2 | .\" | |
| 3 | .\" Permission is granted to make and distribute verbatim copies of this | |
| 4 | .\" manual provided the copyright notice and this permission notice are | |
| 5 | .\" preserved on all copies. | |
| 6 | .\" | |
| 7 | .\" Permission is granted to copy and distribute modified versions of this | |
| 8 | .\" manual under the conditions for verbatim copying, provided that the | |
| 9 | .\" entire resulting derived work is distributed under the terms of a | |
| 10 | .\" permission notice identical to this one. | |
| c13182ef | 11 | .\" |
| fea681da MK |
12 | .\" Since the Linux kernel and libraries are constantly changing, this |
| 13 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
| 14 | .\" responsibility for errors or omissions, or for damages resulting from | |
| 15 | .\" the use of the information contained herein. The author(s) may not | |
| 16 | .\" have taken the same level of care in the production of this manual, | |
| 17 | .\" which is licensed free of charge, as they might when working | |
| 18 | .\" professionally. | |
| c13182ef | 19 | .\" |
| fea681da MK |
20 | .\" Formatted or processed versions of this manual, if unaccompanied by |
| 21 | .\" the source, must acknowledge the copyright and authors of this work. | |
| 22 | .\" | |
| 23 | .\" References consulted: | |
| 24 | .\" Linux libc source code | |
| 25 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
| 26 | .\" 386BSD man pages | |
| 27 | .\" Modified 1993-04-02, David Metcalfe | |
| 28 | .\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu) | |
| cc4615cc | 29 | .TH ON_EXIT 3 2007-07-26 "GNU" "Linux Programmer's Manual" |
| fea681da | 30 | .SH NAME |
| 027df6e0 | 31 | on_exit \- register a function to be called at normal process termination |
| fea681da MK |
32 | .SH SYNOPSIS |
| 33 | .nf | |
| 34 | .B #include <stdlib.h> | |
| 35 | .sp | |
| 36 | .BI "int on_exit(void (*" function ")(int , void *), void *" arg ); | |
| 37 | .fi | |
| cc4615cc MK |
38 | .sp |
| 39 | .in -4n | |
| 40 | Feature Test Macro Requirements for glibc (see | |
| 41 | .BR feature_test_macros (7)): | |
| 42 | .in | |
| 43 | .sp | |
| 44 | .BR on_exit (): | |
| 45 | _BSD_SOURCE || _SVID_SOURCE | |
| fea681da | 46 | .SH DESCRIPTION |
| 60a90ecd MK |
47 | The |
| 48 | .BR on_exit () | |
| 49 | function registers the given \fIfunction\fP to be | |
| 027df6e0 | 50 | called at normal process termination, whether via |
| fea681da | 51 | .BR exit (3) |
| 87ed9800 | 52 | or via return from the program's \fImain\fP(). |
| fea681da MK |
53 | The \fIfunction\fP is passed the argument to |
| 54 | .BR exit (3) | |
| 60a90ecd MK |
55 | and the \fIarg\fP argument from |
| 56 | .BR on_exit (). | |
| fea681da | 57 | .SH "RETURN VALUE" |
| 60a90ecd MK |
58 | The |
| 59 | .BR on_exit () | |
| 60 | function returns the value 0 if successful; otherwise | |
| fea681da MK |
61 | it returns a non-zero value. |
| 62 | .SH "CONFORMING TO" | |
| 63 | This function comes from SunOS 4, but is also present in | |
| c13182ef | 64 | libc4, libc5 and glibc. |
| 68e1685c | 65 | It no longer occurs in Solaris (SunOS 5). |
| fea681da MK |
66 | Avoid this function, and use the standard |
| 67 | .BR atexit (3) | |
| 68 | instead. | |
| 69 | .SH "SEE ALSO" | |
| c62b9eaa | 70 | .BR _exit (2), |
| fea681da MK |
71 | .BR atexit (3), |
| 72 | .BR exit (3) |