pcntl_waitpid() 関数は、 引数 pid で指定した子プロセスが終了する・ カレントのプロセスを終了させるシグナルが送信される・シグナル処理関数を コールするシグナルが送信される のいずれかが発生するまでカレントのプロセスの実行を中断します。 pid でリクエストされた子プロセスが、 コール時に 既に終了している場合("ゾンビ"プロセスと呼ばれます)、この関数は 直ちに処理を返します。子プロセスにより使用される全てのシステム リソースは、解放されます。waitpid のシステムでの動作に関する詳細は、 システムの waitpid(2) についての man ページを参照ください。
pcntl_waitpid() は、終了した子プロセスの プロセス ID を返します。エラーの場合は -1、WNOHANG が使用され、 子プロセスが利用できない場合に 0 を返します。
pidの値は次のどれかとなります。
表 1. pid のとりうる値
| < -1 | プロセスグループ ID が pid の絶対値に等しい 子プロセスを待ちます。 |
| -1 | 全ての子プロセスを待ちます。これは、wait 関数の動作と同じです。 |
| 0 | プロセスグループ ID がコール側のプロセスと等しい子プロセスを 待ちます。 |
| > 0 | プロセス ID が pid の値に等しい 子プロセスを待ちます。 |
注意: Specifying -1 as the pid is equivalent to the functionality pcntl_wait() provides (minus options).
pcntl_waitpid() は、パラメータ status の中にステータス情報を保存します。 このステータスは、次の関数を用いて評価可能です。 pcntl_wifexited()、 pcntl_wifstopped()、 pcntl_wifsignaled()、 pcntl_wexitstatus()、 pcntl_wtermsig() および pcntl_wstopsig() 。
options の値は、次の 2 つのグローバル定数の ゼロまたはそれ以上の論理和です。
表 2. options のとりうる値
| WNOHANG | 子プロセスが終了していない場合に直ちに処理を返します。 |
| WUNTRACED | 停止した子プロセスの場合に処理を返します。そして、ステータス は報告されません。 |
pcntl_fork()、 pcntl_signal()、 pcntl_wifexited()、 pcntl_wifstopped()、 pcntl_wifsignaled()、 pcntl_wexitstatus()、 pcntl_wtermsig() および pcntl_wstopsig() も参照ください。