1.. -*- coding: utf-8; mode: rst -*-
2
3.. _CA_GET_MSG:
4
5==========
6CA_GET_MSG
7==========
8
9Name
10----
11
12CA_GET_MSG
13
14
15Synopsis
16--------
17
18.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
19    :name: CA_GET_MSG
20
21
22Arguments
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
31Description
32-----------
33
34Receives 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
42Return Value
43------------
44
45
46On success 0 is returned.
47
48On error -1 is returned, and the ``errno`` variable is set
49appropriately.
50
51Generic error codes are described at the
52:ref:`Generic Error Codes <gen-errors>` chapter.
53