linux/Documentation/media/uapi/mediactl/media-func-close.rst

.. -*- coding: utf-8; mode: rst -*-

.. _media-func-close:

*************
media close()
*************

Name
====

media-close - Close a media device


Synopsis
========

.. code-block:: c

    #include <unistd.h>


.. c:function:: int close( int fd )
    :name: mc-close

Arguments
=========

``fd``
    File descriptor returned by :c:func:`open() <mc-open>`.


Description
===========

Closes the media device. Resources associated with the file descriptor
are freed. The device configuration remain unchanged.


Return Value
============

:ref:`close() <media-func-close>` returns 0 on success. On error, -1 is returned, and
``errno`` is set appropriately. Possible error codes are:

EBADF
    ``fd`` is not a valid open file descriptor.
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			`.. -- coding: utf-8; mode: rst --`

			`.. _media-func-close:`

			`*************`
			`media close()`
			`*************`

doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 18:14:35 +00:00			`Name`
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 10:58:48 +00:00			`====`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 10:58:48 +00:00			`media-close - Close a media device`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 18:14:35 +00:00
			`Synopsis`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			`========`

			`.. code-block:: c`

			`#include <unistd.h>`


[media] docs-next: stop abusing on the cpp domain Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-08-19 15:00:43 +00:00			`.. c:function:: int close( int fd )`
[media] docs-rst: Convert MC 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. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-08-19 19:59:55 +00:00			`:name: mc-close`
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 10:58:48 +00:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 18:14:35 +00:00			`Arguments`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			`=========`

			``fd``
[media] docs-rst: Convert MC 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. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-08-19 19:59:55 +00:00			File descriptor returned by :c:func:`open() <mc-open>`.
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00

doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 18:14:35 +00:00			`Description`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			`===========`

			`Closes the media device. Resources associated with the file descriptor`
			`are freed. The device configuration remain unchanged.`


doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 18:14:35 +00:00			`Return Value`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			`============`

doc-rst: mediactl: fix some wrong cross references Those cross references should point to media control syscalls, and not to V4L ones. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-05 20:12:37 +00:00			:ref:`close() <media-func-close>` returns 0 on success. On error, -1 is returned, and
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00			``errno`` is set appropriately. Possible error codes are:

			`EBADF`
			``fd`` is not a valid open file descriptor.