Merge commit 'v2.6.39' into 20110526
[linux-2.6.git] / Documentation / DocBook / v4l / media-func-close.xml
1 <refentry id="media-func-close">
2   <refmeta>
3     <refentrytitle>media close()</refentrytitle>
4     &manvol;
5   </refmeta>
6
7   <refnamediv>
8     <refname>media-close</refname>
9     <refpurpose>Close a media device</refpurpose>
10   </refnamediv>
11
12   <refsynopsisdiv>
13     <funcsynopsis>
14       <funcsynopsisinfo>#include &lt;unistd.h&gt;</funcsynopsisinfo>
15       <funcprototype>
16         <funcdef>int <function>close</function></funcdef>
17         <paramdef>int <parameter>fd</parameter></paramdef>
18       </funcprototype>
19     </funcsynopsis>
20   </refsynopsisdiv>
21
22   <refsect1>
23     <title>Arguments</title>
24
25     <variablelist>
26       <varlistentry>
27         <term><parameter>fd</parameter></term>
28         <listitem>
29           <para>&fd;</para>
30         </listitem>
31       </varlistentry>
32     </variablelist>
33   </refsect1>
34
35   <refsect1>
36     <title>Description</title>
37
38     <para>Closes the media device. Resources associated with the file descriptor
39     are freed. The device configuration remain unchanged.</para>
40   </refsect1>
41
42   <refsect1>
43     <title>Return Value</title>
44
45     <para><function>close</function> returns 0 on success. On error, -1 is
46     returned, and <varname>errno</varname> is set appropriately. Possible error
47     codes are:</para>
48
49     <variablelist>
50       <varlistentry>
51         <term><errorcode>EBADF</errorcode></term>
52         <listitem>
53           <para><parameter>fd</parameter> is not a valid open file descriptor.
54           </para>
55         </listitem>
56       </varlistentry>
57     </variablelist>
58   </refsect1>
59 </refentry>