blob: 8ac2443e76c1015414d496f6c14c0458547cec22 [file] [log] [blame]
Mauro Carvalho Chehab059b1c52020-08-26 09:03:09 +02001.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
Mauro Carvalho Chehab937e6802020-09-24 16:57:41 +02002.. c:namespace:: MC
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +01003
4.. _media-func-close:
5
6*************
7media close()
8*************
9
10Name
11====
12
13media-close - Close a media device
14
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010015Synopsis
16========
17
18.. code-block:: c
19
20 #include <unistd.h>
21
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010022.. c:function:: int close( int fd )
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010023
24Arguments
25=========
26
27``fd``
Mauro Carvalho Chehab937e6802020-09-24 16:57:41 +020028 File descriptor returned by :c:func:`open()`.
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010029
30Description
31===========
32
33Closes the media device. Resources associated with the file descriptor
34are freed. The device configuration remain unchanged.
35
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010036Return Value
37============
38
Mauro Carvalho Chehab937e6802020-09-24 16:57:41 +020039:c:func:`close()` returns 0 on success. On error, -1 is returned, and
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010040``errno`` is set appropriately. Possible error codes are:
41
42EBADF
43 ``fd`` is not a valid open file descriptor.