diff options
Diffstat (limited to 'Documentation/DocBook/media/v4l/func-close.xml')
| -rw-r--r-- | Documentation/DocBook/media/v4l/func-close.xml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/func-close.xml b/Documentation/DocBook/media/v4l/func-close.xml new file mode 100644 index 00000000..232920d2 --- /dev/null +++ b/Documentation/DocBook/media/v4l/func-close.xml @@ -0,0 +1,62 @@ +<refentry id="func-close"> + <refmeta> + <refentrytitle>V4L2 close()</refentrytitle> + &manvol; + </refmeta> + + <refnamediv> + <refname>v4l2-close</refname> + <refpurpose>Close a V4L2 device</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <unistd.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>close</function></funcdef> + <paramdef>int <parameter>fd</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><parameter>fd</parameter></term> + <listitem> + <para>&fd;</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Description</title> + + <para>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.</para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para>The function returns <returnvalue>0</returnvalue> on +success, <returnvalue>-1</returnvalue> on failure and the +<varname>errno</varname> is set appropriately. Possible error +codes:</para> + + <variablelist> + <varlistentry> + <term><errorcode>EBADF</errorcode></term> + <listitem> + <para><parameter>fd</parameter> is not a valid open file +descriptor.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> |