oracular (3) on_exit.3.gz

名前

       on_exit - プロセスが正常に終了した際に呼ばれる関数を登録する

書式

       #include <stdlib.h>

       int on_exit(void (*function)(int , void *), void *arg);

   glibc 向けの機能検査マクロの要件 (feature_test_macros(7)  参照):

       on_exit():
           Since glibc 2.19:
               _DEFAULT_SOURCE
           Glibc 2.19 and earlier:
               _BSD_SOURCE || _SVID_SOURCE

説明

       on_exit()    関数は、指定された関数  function  を、プロセスが  正常に終了した際に呼ばれる関数として登録す
       る。正常な終了とは、 exit(3)  またはプログラムの main()  関数の中の  return  命令による終了である。  関数
       function には、直近の exit(3)  の呼び出しで渡された status 引数と on_exit()  の arg 引数が渡される。

       同じ関数を複数回登録してもよい。 登録された関数は登録 1 回につき 1 回呼び出される。

       fork(2)  で作成された場合、子プロセスは親プロセスの登録のコピーを継承する。  exec(3) ファミリーの関数の場
       合、呼び出しに成功すると、 全ての登録が削除される。

返り値

       on_exit()  関数は、成功したら 0 を、そうでなければ 0 以外を返す。

属性

       この節で使用されている用語の説明については、 attributes(7) を参照。

       ┌─────────────────┬───────────────┬─────────┐
       │インターフェース │ 属性          │ 値      │
       ├─────────────────┼───────────────┼─────────┤
       │on_exit()        │ Thread safety │ MT-Safe │
       └─────────────────┴───────────────┴─────────┘

準拠

       この関数は SunOS 4 由来であるが、 glibc にも存在する。 Solaris (SunOS 5) にはもはや存在しない。移植性が必
       要なアプリケーションではこの関数の使用は避け、代わりに標準の atexit(3) を使うこと。

注意

       By the time function is executed, stack (auto)  variables may already have gone out of scope.  Therefore,
       arg should not be a pointer to a stack variable; it may however be a pointer to  a  heap  variable  or  a
       global variable.

関連項目

       _exit(2), atexit(3), exit(3)

この文書について

       この  man ページは Linux man-pages プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告
       に関する情報は https://www.kernel.org/doc/man-pages/ に書かれている。