Mauro Carvalho Chehab | 8e080c2 | 2009-09-13 22:16:04 -0300 | [diff] [blame] | 1 | <refentry id="func-close"> |
| 2 | <refmeta> |
| 3 | <refentrytitle>V4L2 close()</refentrytitle> |
| 4 | &manvol; |
| 5 | </refmeta> |
| 6 | |
| 7 | <refnamediv> |
| 8 | <refname>v4l2-close</refname> |
| 9 | <refpurpose>Close a V4L2 device</refpurpose> |
| 10 | </refnamediv> |
| 11 | |
| 12 | <refsynopsisdiv> |
| 13 | <funcsynopsis> |
| 14 | <funcsynopsisinfo>#include <unistd.h></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 device. Any I/O in progress is terminated and |
| 39 | resources associated with the file descriptor are freed. However data |
| 40 | format parameters, current input or output, control values or other |
| 41 | properties remain unchanged.</para> |
| 42 | </refsect1> |
| 43 | |
| 44 | <refsect1> |
| 45 | <title>Return Value</title> |
| 46 | |
| 47 | <para>The function returns <returnvalue>0</returnvalue> on |
| 48 | success, <returnvalue>-1</returnvalue> on failure and the |
| 49 | <varname>errno</varname> is set appropriately. Possible error |
| 50 | codes:</para> |
| 51 | |
| 52 | <variablelist> |
| 53 | <varlistentry> |
| 54 | <term><errorcode>EBADF</errorcode></term> |
| 55 | <listitem> |
| 56 | <para><parameter>fd</parameter> is not a valid open file |
| 57 | descriptor.</para> |
| 58 | </listitem> |
| 59 | </varlistentry> |
| 60 | </variablelist> |
| 61 | </refsect1> |
| 62 | </refentry> |
| 63 | |
| 64 | <!-- |
| 65 | Local Variables: |
| 66 | mode: sgml |
| 67 | sgml-parent-document: "v4l2.sgml" |
| 68 | indent-tabs-mode: nil |
| 69 | End: |
| 70 | --> |