linux/Documentation/media/uapi/v4l/func-close.rst
Mauro Carvalho Chehab 41d804653e [media] docs-rst: Convert V4L2 uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 21:23:27 -03:00

50 lines
796 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _func-close:
************
V4L2 close()
************
Name
====
v4l2-close - Close a V4L2 device
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: int close( int fd )
:name: v4l2-close
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
Description
===========
Closes the device. Any I/O in progress is terminated and resources
associated with the file descriptor are freed. However data format
parameters, current input or output, control values or other properties
remain unchanged.
Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
set appropriately. Possible error codes:
EBADF
``fd`` is not a valid open file descriptor.