blob: 880995230909f4d2f577b5618341d4954e03843c [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _CA_GET_MSG:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005==========
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006CA_GET_MSG
7==========
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012CA_GET_MSG
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030014
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030016--------
17
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030018.. c:function:: int ioctl(fd, CA_GET_MSG, ca_msg_t *msg)
19 :name: CA_GET_MSG
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030020
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030021
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030022Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030023---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030024
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030025``fd``
26 File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030027
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030028``msg``
29 Undocumented.
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030030
31
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030032Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030033-----------
34
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030035.. note:: This ioctl is undocumented. Documentation is welcome.
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030036
37
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030038Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030039------------
40
41On success 0 is returned, on error -1 and the ``errno`` variable is set
42appropriately. The generic error codes are described at the
43:ref:`Generic Error Codes <gen-errors>` chapter.