Merge tag 'linux-watchdog-4.21-rc1' of git://www.linux-watchdog.org/linux-watchdog
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / frontend_f_close.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _frontend_f_close:
11
12 ***************************
13 Digital TV frontend close()
14 ***************************
15
16 Name
17 ====
18
19 fe-close - Close a frontend device
20
21
22 Synopsis
23 ========
24
25 .. code-block:: c
26
27     #include <unistd.h>
28
29
30 .. c:function:: int close( int fd )
31     :name: dvb-fe-close
32
33 Arguments
34 =========
35
36 ``fd``
37     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
38
39
40 Description
41 ===========
42
43 This system call closes a previously opened front-end device. After
44 closing a front-end device, its corresponding hardware might be powered
45 down automatically.
46
47
48 Return Value
49 ============
50
51 On success 0 is returned.
52
53 On error -1 is returned, and the ``errno`` variable is set
54 appropriately.
55
56 Generic error codes are described at the
57 :ref:`Generic Error Codes <gen-errors>` chapter.