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

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