143051d27SRobert Mustacchi.\" 243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the 343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0. 443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version 543051d27SRobert Mustacchi.\" 1.0 of the CDDL. 643051d27SRobert Mustacchi.\" 743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this 843051d27SRobert Mustacchi.\" source. A copy of the CDDL is also available via the Internet at 943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL. 1043051d27SRobert Mustacchi.\" 1143051d27SRobert Mustacchi.\" 1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc. 1343051d27SRobert Mustacchi.\" 1443051d27SRobert Mustacchi.Dd May 11, 2016 1543051d27SRobert Mustacchi.Dt PFDINFO_ITER 3PROC 1643051d27SRobert Mustacchi.Os 1743051d27SRobert Mustacchi.Sh NAME 1843051d27SRobert Mustacchi.Nm Pfdinfo_iter 1943051d27SRobert Mustacchi.Nd iterate open files in a process 2043051d27SRobert Mustacchi.Sh SYNOPSIS 2143051d27SRobert Mustacchi.Lb libproc 2243051d27SRobert Mustacchi.In libproc.h 2343051d27SRobert Mustacchi.Ft int 2443051d27SRobert Mustacchi.Fo Pfdinfo_iter 2543051d27SRobert Mustacchi.Fa "struct ps_prochandle *P" 2643051d27SRobert Mustacchi.Fa "proc_fdinfo_f *func" 2743051d27SRobert Mustacchi.Fa "void *data" 2843051d27SRobert Mustacchi.Fc 2943051d27SRobert Mustacchi.Sh DESCRIPTION 3043051d27SRobert MustacchiThe 3143051d27SRobert Mustacchi.Fn Pfdinfo_iter 3243051d27SRobert Mustacchifunction iterates over the open files in the process represented by 3343051d27SRobert Mustacchi.Fa P . 3443051d27SRobert Mustacchi.Pp 3543051d27SRobert MustacchiFor each open file, the callback function 3643051d27SRobert Mustacchi.Fa func 3743051d27SRobert Mustacchiwill be invoked and it will be passed the 3843051d27SRobert Mustacchi.Fa data 3943051d27SRobert Mustacchiargument as well as a pointer to a 4043051d27SRobert Mustacchi.Sy prfdinfo_t 4143051d27SRobert Mustacchistructure defined in 4243051d27SRobert Mustacchi.Xr libproc 3LIB . 4343051d27SRobert MustacchiFor the full signature of the 4443051d27SRobert Mustacchi.Vt proc_fdinfo_f 4543051d27SRobert Mustacchisee 4643051d27SRobert Mustacchi.Xr libproc 3LIB . 4743051d27SRobert Mustacchi.Pp 4843051d27SRobert MustacchiThe return value of 4943051d27SRobert Mustacchi.Fa func 50*72d3dbb9SYuri Pankovcontrols whether or not iteration continues. 51*72d3dbb9SYuri PankovIf 5243051d27SRobert Mustacchi.Fa func 5343051d27SRobert Mustacchireturns 5443051d27SRobert Mustacchi.Sy 0 , 55*72d3dbb9SYuri Pankovthen iteration will continue. 56*72d3dbb9SYuri PankovHowever, if 5743051d27SRobert Mustacchi.Fa func 5843051d27SRobert Mustacchiinstead returns a non-zero value, then iteration will halt and that 5943051d27SRobert Mustacchivalue will be used as the return value of the 6043051d27SRobert Mustacchi.Fn Pfdinfo_iter 61*72d3dbb9SYuri Pankovfunction. 62*72d3dbb9SYuri PankovBecause the 6343051d27SRobert Mustacchi.Fn Pfdinfo_iter 6443051d27SRobert Mustacchifunction returns 6543051d27SRobert Mustacchi.Sy -1 6643051d27SRobert Mustacchito an indicate its own errors, it is recommended that the callback 6743051d27SRobert Mustacchifunction does not return 6843051d27SRobert Mustacchi.Sy -1 6943051d27SRobert Mustacchito indicate an error so that the caller may distinguish between the 7043051d27SRobert Mustacchifailure of the callback function and the failure of the 7143051d27SRobert Mustacchi.Fn Pfdinfo_iter 7243051d27SRobert Mustacchifunction. 7343051d27SRobert Mustacchi.Sh RETURN VALUES 7443051d27SRobert MustacchiUpon successful completion, the 7543051d27SRobert Mustacchi.Fn Pfdinfo_iter 7643051d27SRobert Mustacchireturns 7743051d27SRobert Mustacchi.Sy 0 . 7843051d27SRobert MustacchiOtherwise, if there was an internal error then 7943051d27SRobert Mustacchi.Sy -1 80*72d3dbb9SYuri Pankovis returned. 81*72d3dbb9SYuri PankovOtherwise, if the callback function 8243051d27SRobert Mustacchi.Fa func 8343051d27SRobert Mustacchireturns non-zero, then its return value will be returned instead. 8443051d27SRobert Mustacchi.Sh INTERFACE STABILITY 8543051d27SRobert Mustacchi.Sy Uncommitted 8643051d27SRobert Mustacchi.Sh MT-LEVEL 8743051d27SRobert MustacchiSee 8843051d27SRobert Mustacchi.Sy LOCKING 8943051d27SRobert Mustacchiin 9043051d27SRobert Mustacchi.Xr libproc 3LIB . 9143051d27SRobert Mustacchi.Sh SEE ALSO 9243051d27SRobert Mustacchi.Xr libproc 3LIB 93