Changeset View
Changeset View
Standalone View
Standalone View
head/lib/libc/sys/closefrom.2
| Show All 19 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd June 12, 2009 | .Dd April 12, 2020 | ||||
| .Dt CLOSEFROM 2 | .Dt CLOSEFROM 2 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm closefrom | .Nm closefrom , | ||||
| .Nm close_range | |||||
| .Nd delete open file descriptors | .Nd delete open file descriptors | ||||
| .Sh LIBRARY | .Sh LIBRARY | ||||
| .Lb libc | .Lb libc | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .In unistd.h | .In unistd.h | ||||
| .Ft void | .Ft void | ||||
| .Fn closefrom "int lowfd" | .Fn closefrom "int lowfd" | ||||
| .Ft int | |||||
| .Fn close_range "u_int lowfd" "u_int highfd" "int flags" | |||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Fn closefrom | .Fn closefrom | ||||
| system call deletes all open file descriptors greater than or equal to | system call deletes all open file descriptors greater than or equal to | ||||
| .Fa lowfd | .Fa lowfd | ||||
| from the per-process object reference table. | from the per-process object reference table. | ||||
| Any errors encountered while closing file descriptors are ignored. | Any errors encountered while closing file descriptors are ignored. | ||||
| .Pp | |||||
| The | |||||
| .Fn close_range | |||||
| system call deletes all open file descriptors between | |||||
| .Fa lowfd | |||||
| and | |||||
| .Fa highfd | |||||
| inclusive, clamped to the range of open file descriptors. | |||||
| Any errors encountered while closing file descriptors are ignored. | |||||
| There are currently no defined | |||||
| .Fa flags . | |||||
| .Sh RETURN VALUES | |||||
| Upon successful completion, | |||||
| .Fn close_range | |||||
| returns a value | |||||
| of 0. | |||||
| Otherwise, a value of -1 is returned and the global variable | |||||
| .Va errno | |||||
| is set to indicate the error. | |||||
| .Sh ERRORS | |||||
| The | |||||
| .Fn close_range | |||||
| system call | |||||
| will fail if: | |||||
| .Bl -tag -width Er | |||||
| .It Bq Er EINVAL | |||||
| The | |||||
| .Fa highfd | |||||
| argument is lower than the | |||||
| .Fa lowfd | |||||
| argument. | |||||
| .It Bq Er EINVAL | |||||
| An invalid flag was set. | |||||
| .El | |||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr close 2 | .Xr close 2 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| The | The | ||||
| .Fn closefrom | .Fn closefrom | ||||
| function first appeared in | function first appeared in | ||||
| .Fx 8.0 . | .Fx 8.0 . | ||||