Documentation/media/uapi/dvb/ca-get-msg.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _CA_GET_MSG:
  11
  12 ==========
  13 CA_GET_MSG
  14 ==========
  15
  16 Name
  17 ----
  18
  19 CA_GET_MSG
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
  26     :name: CA_GET_MSG
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
  34
  35 ``msg``
  36   Pointer to struct :c:type:`ca_msg`.
  37
  38 Description
  39 -----------
  40
  41 Receives a message via a CI CA module.
  42
  43 .. note::
  44
  45    Please notice that, on most drivers, this is done by reading from
  46    the /dev/adapter?/ca? device node.
  47
  48
  49 Return Value
  50 ------------
  51
  52
  53 On success 0 is returned.
  54
  55 On error -1 is returned, and the ``errno`` variable is set
  56 appropriately.
  57
  58 Generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.