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
  32 .. c:type:: struct ca_msg
  33
  34 .. flat-table:: struct ca_msg
  35     :header-rows:  1
  36     :stub-columns: 0
  37
  38     -
  39       - type
  40       - name
  41       - description
  42     -
  43        - unsigned int
  44        - index
  45        -
  46
  47     -
  48        - unsigned int
  49        - type
  50        -
  51
  52     -
  53        - unsigned int
  54        - length
  55        -
  56
  57     -
  58        - unsigned char
  59        - msg[256]
  60        -
  61
  62
  63 Description
  64 -----------
  65
  66 .. note:: This ioctl is undocumented. Documentation is welcome.
  67
  68
  69 Return Value
  70 ------------
  71
  72 On success 0 is returned, on error -1 and the ``errno`` variable is set
  73 appropriately. The generic error codes are described at the
  74 :ref:`Generic Error Codes <gen-errors>` chapter.