close (2)

Leading comments

 Copyright (c) 1980, 1991, 1993, 1994
	The Regents of the University of California.  All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and t...

(The comments found at the beginning of the groff file "man2/close.2freebsd".)

NAME

close - delete a descriptor

LIBRARY

Lb libc

SYNOPSIS

In unistd.h Ft int Fn close int fd

DESCRIPTION

The Fn close system call deletes a descriptor from the per-process object reference table. If this is the last reference to the underlying object, the object will be deactivated. For example, on the last close of a file the current seek pointer associated with the file is lost; on the last close of a socket(2) associated naming information and queued data are discarded; on the last close of a file holding an advisory lock the lock is released (see further flock(2)). However, the semantics of System V and St -p1003.1-88 dictate that all fcntl(2) advisory record locks associated with a file for a given process are removed when any file descriptor for that file is closed by that process.

When a process exits, all associated file descriptors are freed, but since there is a limit on active descriptors per processes, the Fn close system call is useful when a large quantity of file descriptors are being handled.

When a process forks (see fork(2)), all descriptors for the new child process reference the same objects as they did in the parent before the fork. If a new process is then to be run using execve(2), the process would normally inherit these descriptors. Most of the descriptors can be rearranged with dup2(2) or deleted with Fn close before the execve(2) is attempted, but if some of these descriptors will still be needed if the execve fails, it is necessary to arrange for them to be closed if the execve succeeds. For this reason, the call ``fcntl(d, F_SETFD, FD_CLOEXEC) '' is provided, which arranges that a descriptor will be closed after a successful execve; the call ``fcntl(d, F_SETFD, 0) '' restores the default, which is to not close the descriptor.

RETURN VALUES

Rv -std close

ERRORS

The Fn close system call will fail if:

Bq Er EBADF

The Fa fd argument is not an active descriptor.

Bq Er EINTR

An interrupt was received.

Bq Er ENOSPC

The underlying object did not fit, cached data was lost.

Bq Er ECONNRESET

The underlying object was a stream socket that was shut down by the peer before all pending data was delivered.

In case of any error except Er EBADF , the supplied file descriptor is deallocated and therefore is no longer valid.

SEE ALSO

accept(2), closefrom(2), execve(2), fcntl(2), flock(2), open(2), pipe(2), socket(2), socketpair(2)

STANDARDS

The Fn close system call is expected to conform to St -p1003.1-90 .

HISTORY

The Fn close function appeared in AT&T System v7 .