GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / userspace-api / media / mediactl / media-func-close.rst
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: MC
3
4 .. _media-func-close:
5
6 *************
7 media close()
8 *************
9
10 Name
11 ====
12
13 media-close - Close a media device
14
15 Synopsis
16 ========
17
18 .. code-block:: c
19
20     #include <unistd.h>
21
22 .. c:function:: int close( int fd )
23
24 Arguments
25 =========
26
27 ``fd``
28     File descriptor returned by :c:func:`open()`.
29
30 Description
31 ===========
32
33 Closes the media device. Resources associated with the file descriptor
34 are freed. The device configuration remain unchanged.
35
36 Return Value
37 ============
38
39 :c:func:`close()` returns 0 on success. On error, -1 is returned, and
40 ``errno`` is set appropriately. Possible error codes are:
41
42 EBADF
43     ``fd`` is not a valid open file descriptor.