summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/ca-get-msg.rst
blob: 121588da3ef1806176318037b0352c89a2087bb1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
.. -*- coding: utf-8; mode: rst -*-

.. _CA_GET_MSG:

==========
CA_GET_MSG
==========

Name
----

CA_GET_MSG


Synopsis
--------

.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
    :name: CA_GET_MSG


Arguments
---------

``fd``
  File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.

``msg``
  Pointer to struct :c:type:`ca_msg`.


.. c:type:: struct ca_msg

.. flat-table:: struct ca_msg
    :header-rows:  1
    :stub-columns: 0

    -
      - type
      - name
      - description
    -
       - unsigned int
       - index
       -

    -
       - unsigned int
       - type
       -

    -
       - unsigned int
       - length
       -

    -
       - unsigned char
       - msg[256]
       -


Description
-----------

.. note:: This ioctl is undocumented. Documentation is welcome.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.