Documentation/DocBook/media/v4l/cec-func-close.xml

   1 <refentry id="cec-func-close">
   2   <refmeta>
   3     <refentrytitle>cec close()</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>cec-close</refname>
   9     <refpurpose>Close a cec 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>
  39       Note: this documents the proposed CEC API. This API is not yet finalized and
  40       is currently only available as a staging kernel module.
  41     </para>
  42
  43     <para>Closes the cec device. Resources associated with the file descriptor
  44     are freed. The device configuration remain unchanged.</para>
  45   </refsect1>
  46
  47   <refsect1>
  48     <title>Return Value</title>
  49
  50     <para><function>close</function> returns 0 on success. On error, -1 is
  51     returned, and <varname>errno</varname> is set appropriately. Possible error
  52     codes are:</para>
  53
  54     <variablelist>
  55       <varlistentry>
  56         <term><errorcode>EBADF</errorcode></term>
  57         <listitem>
  58           <para><parameter>fd</parameter> is not a valid open file descriptor.
  59           </para>
  60         </listitem>
  61       </varlistentry>
  62     </variablelist>
  63   </refsect1>
  64 </refentry>