Merge tag 'vfio-v4.20-rc1.v2' of git://github.com/awilliam/linux-vfio
[sfrench/cifs-2.6.git] / Documentation / media / uapi / mediactl / request-func-close.rst
1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections
2
3 .. _request-func-close:
4
5 ***************
6 request close()
7 ***************
8
9 Name
10 ====
11
12 request-close - Close a request file descriptor
13
14
15 Synopsis
16 ========
17
18 .. code-block:: c
19
20     #include <unistd.h>
21
22
23 .. c:function:: int close( int fd )
24     :name: req-close
25
26 Arguments
27 =========
28
29 ``fd``
30     File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`.
31
32
33 Description
34 ===========
35
36 Closes the request file descriptor. Resources associated with the request
37 are freed once all file descriptors associated with the request are closed
38 and the driver has completed the request.
39 See :ref:`here <media-request-life-time>` for more information.
40
41
42 Return Value
43 ============
44
45 :ref:`close() <request-func-close>` returns 0 on success. On error, -1 is
46 returned, and ``errno`` is set appropriately. Possible error codes are:
47
48 EBADF
49     ``fd`` is not a valid open file descriptor.