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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CA_GET_MSG:
   4
   5 ==========
   6 CA_GET_MSG
   7 ==========
   8
   9 Name
  10 ----
  11
  12 CA_GET_MSG
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
  19     :name: CA_GET_MSG
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
  27
  28 ``msg``
  29   Pointer to struct :c:type:`ca_msg`.
  30
  31 Description
  32 -----------
  33
  34 Receives a message via a CI CA module.
  35
  36 .. note::
  37
  38    Please notice that, on most drivers, this is done by reading from
  39    the /dev/adapter?/ca? device node.
  40
  41
  42 Return Value
  43 ------------
  44
  45
  46 On success 0 is returned.
  47
  48 On error -1 is returned, and the ``errno`` variable is set
  49 appropriately.
  50
  51 Generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.